diff --git a/xml/System.Windows.Annotations.Storage/AnnotationStore.xml b/xml/System.Windows.Annotations.Storage/AnnotationStore.xml index 128243765f7..78ba80255f5 100644 --- a/xml/System.Windows.Annotations.Storage/AnnotationStore.xml +++ b/xml/System.Windows.Annotations.Storage/AnnotationStore.xml @@ -88,7 +88,7 @@ is added to the store its globally unique identifier (GUID) property is set to a new value. When is called, its property is checked to see if the already has been added to the store. If the already has been added and exists in the store (as determined by its property) an error is thrown. + When a new is added to the store its globally unique identifier (GUID) property is set to a new value. When is called, its property is checked to see if the already has been added to the store. If the already has been added and exists in the store (as determined by its property) an error is thrown. ]]> @@ -130,7 +130,7 @@ event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. + The event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. ]]> @@ -173,7 +173,7 @@ event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. + The event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. ]]> @@ -217,9 +217,9 @@ to `false` and call directly when appropriate. + Applications that use an explicit-save model can set to `false` and call directly when appropriate. - Applications that use an implicit-save model can set to `true` to cause to be called automatically after every store operation (add, delete, or modify). + Applications that use an implicit-save model can set to `true` to cause to be called automatically after every store operation (add, delete, or modify). ]]> @@ -256,7 +256,7 @@ event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. + The event can be used to monitor changes to the annotation contained in the store without the need to register on each individually. ]]> @@ -303,7 +303,7 @@ and methods. + The following example shows use of the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete"::: @@ -359,12 +359,12 @@ when finished with the . After calling the application can release all references to the to allow the garbage collector to reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + Applications should call when finished with the . After calling the application can release all references to the to allow the garbage collector to reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). - The public method calls the protected `(Boolean)` method with the `disposing` parameter of `true` to release all managed and unmanaged resources. + The public method calls the protected `(Boolean)` method with the `disposing` parameter of `true` to release all managed and unmanaged resources. > [!NOTE] -> Call before the last reference to the is released. If is not called, resources will not be freed until the garbage collector calls the store's method. +> Call before the last reference to the is released. If is not called, resources will not be freed until the garbage collector calls the store's method. ]]> @@ -405,9 +405,9 @@ method is called by the public and methods. The public invokes the protected `(Boolean)` method with the `disposing` parameter set to `true`. invokes with `disposing` set to `false`. + This protected method is called by the public and methods. The public invokes the protected `(Boolean)` method with the `disposing` parameter set to `true`. invokes with `disposing` set to `false`. - When the `disposing` parameter is `true`, releases all resources held by any managed objects that the references. also invokes the `Dispose()` method of each referenced object. + When the `disposing` parameter is `true`, releases all resources held by any managed objects that the references. also invokes the `Dispose()` method of each referenced object. ]]> @@ -449,7 +449,7 @@ method. The application program should not call directly. is automatically invoked during garbage collection unless disabled by a call to the method. + This method overrides base method. The application program should not call directly. is automatically invoked during garbage collection unless disabled by a call to the method. For more information, see [Finalize Methods and Destructors](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/0s71x931(v%3dvs.100)), [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged), and [Overriding the Finalize Method](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). @@ -487,19 +487,19 @@ to `false` and call directly when appropriate. + Applications that use an explicit-save model can set to `false` and call directly when appropriate. - Applications that use an implicit-save model can set the to `true` to cause to be called automatically after every store operation (add, delete, or modify). + Applications that use an implicit-save model can set the to `true` to cause to be called automatically after every store operation (add, delete, or modify). ## Examples - The following example shows how to use the method when the application closes the . + The following example shows how to use the method when the application closes the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/AnnotationsHelperXps.cs" id="Snippetstopannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/annotationshelperxps.vb" id="Snippetstopannotations"::: - The following example shows use of the and methods. + The following example shows use of the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete"::: @@ -558,7 +558,7 @@ method to determine if there are any annotations contained in the store. + The following example shows how to use the method to determine if there are any annotations contained in the store. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile"::: @@ -598,7 +598,7 @@ method to determine if there are any annotations contained in the store. + The following example shows how to use the method to determine if there are any annotations contained in the store. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile"::: @@ -644,7 +644,7 @@ method internally uses the method of the class to search and match for the annotations to return. + This method internally uses the method of the class to search and match for the annotations to return. ]]> diff --git a/xml/System.Windows.Annotations.Storage/StoreContentChangedEventArgs.xml b/xml/System.Windows.Annotations.Storage/StoreContentChangedEventArgs.xml index 4c9b098fd72..406e5b0387b 100644 --- a/xml/System.Windows.Annotations.Storage/StoreContentChangedEventArgs.xml +++ b/xml/System.Windows.Annotations.Storage/StoreContentChangedEventArgs.xml @@ -27,7 +27,7 @@ data includes the associated with the event and the of or . + The data includes the associated with the event and the of or . ]]> @@ -146,7 +146,7 @@ is specified by the property. + The operation performed with the is specified by the property. ]]> diff --git a/xml/System.Windows.Annotations.Storage/XmlStreamStore.xml b/xml/System.Windows.Annotations.Storage/XmlStreamStore.xml index 564c947d5eb..63249517513 100644 --- a/xml/System.Windows.Annotations.Storage/XmlStreamStore.xml +++ b/xml/System.Windows.Annotations.Storage/XmlStreamStore.xml @@ -105,7 +105,7 @@ constructor enables the registration of application-specific known namespaces. + This constructor enables the registration of application-specific known namespaces. The `knownNamespace` dictionary defines application namespaces that are used when you store custom content as part of an annotation. The dictionary key is the primary namespace known to the application program. The namespace key is associated with a value list of older namespaces that are compatible with the "key" namespace. When annotations are loaded all namespaces from this list will be replaced by the "key" namespace. @@ -157,7 +157,7 @@ is called, the of the is checked to see whether the already has been added to the store. If the already has been added and is in the store an error is thrown. + When is called, the of the is checked to see whether the already has been added to the store. If the already has been added and is in the store an error is thrown. ]]> @@ -235,7 +235,7 @@ and methods. + The following example shows use of the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete"::: @@ -311,12 +311,12 @@ method when the application closes the . + The following example shows how to use the method when the application closes the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/AnnotationsHelperXps.cs" id="Snippetstopannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/annotationshelperxps.vb" id="Snippetstopannotations"::: - The following example shows use of the and methods. + The following example shows use of the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete"::: @@ -377,7 +377,7 @@ method to determine whether there are any annotations contained in the store. + The following example shows how to use the method to determine whether there are any annotations contained in the store. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile"::: @@ -417,12 +417,12 @@ method will never return `null`; however the list may be empty if the store contains no annotations. + The method will never return `null`; however the list may be empty if the store contains no annotations. ## Examples - The following example shows how to use the method to determine whether there are any annotations in the store. + The following example shows how to use the method to determine whether there are any annotations in the store. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile"::: @@ -468,12 +468,12 @@ method internally uses the method of the class to search and match for the annotations to return. + This method internally uses the method of the class to search and match for the annotations to return. ## Examples - The following example shows how to use the method to determine whether there are any annotations in the store. + The following example shows how to use the method to determine whether there are any annotations in the store. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile"::: @@ -517,7 +517,7 @@ will return `null`, even those namespaces registered through the `knownNamespaces` parameter of the constructor. + The `name` parameter works only for predefined Microsoft Annotations Framework namespaces. For any other namespace given in the `name` parameter will return `null`, even those namespaces registered through the `knownNamespaces` parameter of the constructor. The namespaces predefined by the Annotations Framework include the following: @@ -572,7 +572,7 @@ ## Remarks The property will never return `null`, however the returned list can be empty if no namespaces are ignored. - helps in XML markup compatibility when the program reads annotation content created by different versions of the Microsoft Annotations Framework. When an older application is given annotation content created using a newer version of the Annotations Framework, returns a list of the XML namespaces for elements and attributes not known to the older framework. Unknown XML elements and attributes associated with newer namespaces are ignored when the annotation content is read and deserialized by the older application. For more information, see the [XML Markup Compatibility Specification](/office/open-xml/general/introduction-to-markup-compatibility#markup-compatibility-in-the-open-xml-file-formats-specification). + helps in XML markup compatibility when the program reads annotation content created by different versions of the Microsoft Annotations Framework. When an older application is given annotation content created using a newer version of the Annotations Framework, returns a list of the XML namespaces for elements and attributes not known to the older framework. Unknown XML elements and attributes associated with newer namespaces are ignored when the annotation content is read and deserialized by the older application. For more information, see the [XML Markup Compatibility Specification](/office/open-xml/general/introduction-to-markup-compatibility#markup-compatibility-in-the-open-xml-file-formats-specification). ]]> diff --git a/xml/System.Windows.Annotations/Annotation.xml b/xml/System.Windows.Annotations/Annotation.xml index 6dc43f05fd3..2cd440b4392 100644 --- a/xml/System.Windows.Annotations/Annotation.xml +++ b/xml/System.Windows.Annotations/Annotation.xml @@ -39,17 +39,17 @@ ## Remarks represents a single annotation with all associated anchoring and content data. An annotation consists of the following main elements. -- Zero, one, or more that identify what is being annotated. +- Zero, one, or more that identify what is being annotated. -- Zero, one, or more that contain the user data for the annotation. +- Zero, one, or more that contain the user data for the annotation. -- Zero, one, or more that define who created the annotation. +- Zero, one, or more that define who created the annotation. -- A that specifies the date and time when the annotation was created. +- A that specifies the date and time when the annotation was created. -- A that specifies when the annotation was last updated. +- A that specifies when the annotation was last updated. -- A unique annotation (a globally unique identifier (GUID)). +- A unique annotation (a globally unique identifier (GUID)). ]]> @@ -244,9 +244,9 @@ in the collection identifies a data selection to which the annotation is bound (in other words, "the data selection that is being annotated"). While most annotations refer to a single data selection and contain just one anchor , multiple anchors can occur if a single annotation refers to multiple data selections. + Each in the collection identifies a data selection to which the annotation is bound (in other words, "the data selection that is being annotated"). While most annotations refer to a single data selection and contain just one anchor , multiple anchors can occur if a single annotation refers to multiple data selections. - The returned collection is never null; however, the collection may contain zero elements. + The returned collection is never null; however, the collection may contain zero elements. ]]> @@ -288,10 +288,10 @@ name passed as a parameter to the constructor. + The returned annotation type is the name passed as a parameter to the constructor. > [!NOTE] -> returns `null` if the annotation was incorrectly constructed by using a parameterless constructor without parameters. (The parameterless constructor without parameters does not fully initialize the instance and is used only internally in combination with XML serialization.) To create a new annotation, applications should use the constructor that takes an as a parameter. +> returns `null` if the annotation was incorrectly constructed by using a parameterless constructor without parameters. (The parameterless constructor without parameters does not fully initialize the instance and is used only internally in combination with XML serialization.) To create a new annotation, applications should use the constructor that takes an as a parameter. ]]> @@ -362,7 +362,7 @@ collection is never `null`; however, the collection can contain zero elements if no author is specified. + The returned collection is never `null`; however, the collection can contain zero elements if no author is specified. ]]> @@ -400,7 +400,7 @@ occurs on any modification to a cargo subpart, such as a change to an in the collection of a cargo. + In addition to when a cargo is added or removed, occurs on any modification to a cargo subpart, such as a change to an in the collection of a cargo. ]]> @@ -442,9 +442,9 @@ in the collection contains user-defined data for the annotation. + Each in the collection contains user-defined data for the annotation. - The returned collection is never null; however, the collection may contain zero elements if there is no user data for the annotation. + The returned collection is never null; however, the collection may contain zero elements if there is no user data for the annotation. ]]> @@ -488,7 +488,7 @@ ## Remarks > [!NOTE] -> returns if the annotation was incorrectly created by using the default constructor without parameters. An constructor with parameters should be used to correctly instantiate a new annotation. +> returns if the annotation was incorrectly created by using the default constructor without parameters. An constructor with parameters should be used to correctly instantiate a new annotation. ]]> @@ -566,7 +566,7 @@ ## Remarks > [!NOTE] -> returns if the annotation was instantiated by using the default constructor without parameters. An constructor with parameters should be used to correctly instantiate a new annotation with a valid GUID. +> returns if the annotation was instantiated by using the default constructor without parameters. An constructor with parameters should be used to correctly instantiate a new annotation with a valid GUID. ]]> diff --git a/xml/System.Windows.Annotations/AnnotationAction.xml b/xml/System.Windows.Annotations/AnnotationAction.xml index 11a9be9494b..4a8db75f6a6 100644 --- a/xml/System.Windows.Annotations/AnnotationAction.xml +++ b/xml/System.Windows.Annotations/AnnotationAction.xml @@ -23,11 +23,11 @@ Specifies the actions that occur with author, anchor, and cargo resources. - defines the operations that occur to an annotation's , , and properties. - + defines the operations that occur to an annotation's , , and properties. + ]]> diff --git a/xml/System.Windows.Annotations/AnnotationDocumentPaginator.xml b/xml/System.Windows.Annotations/AnnotationDocumentPaginator.xml index 7d47b0deff8..f46050e4af4 100644 --- a/xml/System.Windows.Annotations/AnnotationDocumentPaginator.xml +++ b/xml/System.Windows.Annotations/AnnotationDocumentPaginator.xml @@ -27,7 +27,7 @@ class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. @@ -55,7 +55,7 @@ class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. ]]> @@ -93,9 +93,9 @@ . If needed you can use one of the alternate constructor overloads to set the text to a different setting. + By default this constructor sets the text flow direction to . If needed you can use one of the alternate constructor overloads to set the text to a different setting. - The class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. ]]> @@ -139,14 +139,14 @@ . If needed you can use one of the alternate constructor overloads to set the text to a different setting. + By default this constructor sets the text flow direction to . If needed you can use one of the alternate constructor overloads to set the text to a different setting. - The class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. ## Examples - The following example shows use of the constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/Window1.xaml.cs" id="Snippetdocviewannxpsprint"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/window1.xaml.vb" id="Snippetdocviewannxpsprint"::: @@ -192,7 +192,7 @@ class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. ]]> @@ -232,7 +232,7 @@ class wraps the specified to the constructor to add the user annotations to the pages for printing. + The class wraps the specified to the constructor to add the user annotations to the pages for printing. ]]> @@ -302,9 +302,9 @@ returns, will be `true` and the property will reflect the total number of pages. + Immediately after returns, will be `true` and the property will reflect the total number of pages. - The number of pages may change if the annotation content is modified or the is changed. + The number of pages may change if the annotation content is modified or the is changed. ]]> @@ -344,7 +344,7 @@ method if the application wishes to cancel the asynchronous operation before completion. + The `userState` parameter is intended for use with method if the application wishes to cancel the asynchronous operation before completion. ]]> @@ -423,7 +423,7 @@ method if the application wishes to cancel the asynchronous operation before completion. + The `userState` parameter is intended for use with method if the application wishes to cancel the asynchronous operation before completion. ]]> @@ -464,7 +464,7 @@ may switch from `true` to `false` and recomputed if a change to the content or triggers repagination. + may switch from `true` to `false` and recomputed if a change to the content or triggers repagination. ]]> @@ -500,7 +500,7 @@ may change from `true` to `false` and recomputed if a change to the content or triggers repagination. + may change from `true` to `false` and recomputed if a change to the content or triggers repagination. ]]> @@ -536,7 +536,7 @@ gets or sets the *suggested* size for formatting pages. Use the property to get the actual size of the page (if it is required the actual size may be cropped from the suggested ). + gets or sets the *suggested* size for formatting pages. Use the property to get the actual size of the page (if it is required the actual size may be cropped from the suggested ). ]]> diff --git a/xml/System.Windows.Annotations/AnnotationHelper.xml b/xml/System.Windows.Annotations/AnnotationHelper.xml index 64738996b3c..90ebe1974f8 100644 --- a/xml/System.Windows.Annotations/AnnotationHelper.xml +++ b/xml/System.Windows.Annotations/AnnotationHelper.xml @@ -57,13 +57,13 @@ The annotation service from which to remove highlight annotations. Clears all highlight annotations from the current selection of the viewer control associated with the given . - performs no operation. - - If the current viewer selection overlaps a highlight only partially, only the portion of the selection that overlaps is cleared and the unselected portion of the annotation highlight remains. - + performs no operation. + + If the current viewer selection overlaps a highlight only partially, only the portion of the selection that overlaps is cleared and the unselected portion of the annotation highlight remains. + ]]> @@ -109,28 +109,28 @@ Creates a highlight annotation on the current selection of the viewer control associated with the specified . The highlight annotation; or , if there is no selected content to highlight. - , , , , or control specified to the constructor. - - If there is no selected content (the selection length is zero length), no annotation is created and an is thrown. - - `author` can be specified as `null` in which case no author is defined. - - If `highlightBrush` is `null`, the default highlight brush of the given annotation `service` is used. - - The given annotation `service` must be enabled by means of a call to prior to calling . - + , , , , or control specified to the constructor. + + If there is no selected content (the selection length is zero length), no annotation is created and an is thrown. + + `author` can be specified as `null` in which case no author is defined. + + If `highlightBrush` is `null`, the default highlight brush of the given annotation `service` is used. + + The given annotation `service` must be enabled by means of a call to prior to calling . + ]]> is . - is not enabled. - - -or- - + is not enabled. + + -or- + in not a . The viewer control contains no content selection. @@ -170,17 +170,17 @@ Creates an ink sticky note annotation on the current selection of the viewer control associated with the specified . The ink sticky note annotation; or , if there is no selected content to annotate. - , , , , or control specified to the constructor. - - If there is no user-selected content (the selection length is zero length), no annotation is created and an is thrown. - - `author` can be specified as `null` in which case no author is defined. - - The given annotation `service` must be enabled by means of a call to prior to calling . - + , , , , or control specified to the constructor. + + If there is no user-selected content (the selection length is zero length), no annotation is created and an is thrown. + + `author` can be specified as `null` in which case no author is defined. + + The given annotation `service` must be enabled by means of a call to prior to calling . + ]]> @@ -226,17 +226,17 @@ Creates a text sticky note annotation on the current selection of the viewer control associated with the specified . The text sticky note annotation; or , if there is no selected content to annotate. - , , , , or control specified to the constructor. - - If there is no user-selected content (the selection length is zero length), no annotation is created and an is thrown. - - `author` can be specified as `null` in which case no author is defined. - - The given annotation `service` must be enabled by means of a call to prior to calling . - + , , , , or control specified to the constructor. + + If there is no user-selected content (the selection length is zero length), no annotation is created and an is thrown. + + `author` can be specified as `null` in which case no author is defined. + + The given annotation `service` must be enabled by means of a call to prior to calling . + ]]> @@ -279,13 +279,13 @@ The annotation service from which to delete ink sticky note annotations. Deletes ink sticky note annotations that are wholly contained within the current selection of the viewer control associated with the given . - contains no user selection or the user selection does not wholly contain any ink sticky note annotations, performs no operation. - - The given annotation `service` must be enabled by means of a call to prior to calling . - + contains no user selection or the user selection does not wholly contain any ink sticky note annotations, performs no operation. + + The given annotation `service` must be enabled by means of a call to prior to calling . + ]]> @@ -327,13 +327,13 @@ The annotation service from which to delete text sticky note annotations. Deletes text sticky note annotations that are wholly contained within the current selection of the viewer control associated with the given . - contains no user selection or the user selection does not wholly contain any text sticky note annotations, performs no operation. - - The given annotation `service` must be enabled by means of a call to prior to calling . - + contains no user selection or the user selection does not wholly contain any text sticky note annotations, performs no operation. + + The given annotation `service` must be enabled by means of a call to prior to calling . + ]]> @@ -378,16 +378,16 @@ Returns an object that provides anchoring information, such as the anchor location, about the specified annotation. An object that provides anchoring information about the specified annotation, or if it cannot be resolved. - diff --git a/xml/System.Windows.Annotations/AnnotationResource.xml b/xml/System.Windows.Annotations/AnnotationResource.xml index 355feb96d5e..009110fd32e 100644 --- a/xml/System.Windows.Annotations/AnnotationResource.xml +++ b/xml/System.Windows.Annotations/AnnotationResource.xml @@ -41,9 +41,9 @@ elements are used to model (the data that is being annotated) and (the data provided by the user such as a text note) in an . + elements are used to model (the data that is being annotated) and (the data provided by the user such as a text note) in an . - Through the use of an can refer to the content, directly contain the content, or both. + Through the use of an can refer to the content, directly contain the content, or both. ]]> @@ -84,7 +84,7 @@ constructor that accepts a specified `name` parameter. + This constructor is intended for annotation serializer use only. For application needs, use the constructor that accepts a specified `name` parameter. ]]> @@ -120,7 +120,7 @@ constructor that accepts a specified `name` parameter. + This constructor is intended for annotation serializer use only. For application needs, use the constructor that accepts a specified `name` parameter. ]]> @@ -160,7 +160,7 @@ ## Remarks The `name` parameter is provided for convenience only and no validation is performed on the string. - The constructor automatically creates a GUID that is accessible through the property. + The constructor automatically creates a GUID that is accessible through the property. ]]> @@ -246,7 +246,7 @@ never returns `null`; however the collection may be empty if the resource contains no content. + never returns `null`; however the collection may be empty if the resource contains no content. ]]> diff --git a/xml/System.Windows.Annotations/AnnotationResourceChangedEventArgs.xml b/xml/System.Windows.Annotations/AnnotationResourceChangedEventArgs.xml index 03cb87dc6d8..91182f8deb2 100644 --- a/xml/System.Windows.Annotations/AnnotationResourceChangedEventArgs.xml +++ b/xml/System.Windows.Annotations/AnnotationResourceChangedEventArgs.xml @@ -24,11 +24,11 @@ Provides data for the and events. - data includes the that raised the event, the anchor or cargo resource associated with the event, and the action that was taken - , , or . - + data includes the that raised the event, the anchor or cargo resource associated with the event, and the action that was taken - , , or . + ]]> @@ -105,11 +105,11 @@ Gets the action of the annotation . The action of the annotation . - is called when an or resource is , , or . - + is called when an or resource is , , or . + ]]> diff --git a/xml/System.Windows.Annotations/AnnotationService.xml b/xml/System.Windows.Annotations/AnnotationService.xml index bf47b976018..8584595758c 100644 --- a/xml/System.Windows.Annotations/AnnotationService.xml +++ b/xml/System.Windows.Annotations/AnnotationService.xml @@ -63,7 +63,7 @@ ## Examples - The following example shows use of the constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstartannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstartannotations"::: @@ -102,7 +102,7 @@ constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstartannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstartannotations"::: @@ -142,7 +142,7 @@ constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstartannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstartannotations"::: @@ -193,7 +193,7 @@ ## Examples - The following example shows use of the constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstartannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstartannotations"::: @@ -482,12 +482,12 @@ is called all annotations become hidden. + When is called all annotations become hidden. ## Examples - The following example shows how to use the method when you stop the . + The following example shows how to use the method when you stop the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstopannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstopannotations"::: @@ -531,12 +531,12 @@ is called all annotations in the viewer control window are displayed. (The viewer control associated with the annotation service is specified in the parameter to the constructor.) + When is called all annotations in the viewer control window are displayed. (The viewer control associated with the annotation service is specified in the parameter to the constructor.) ## Examples - The following example shows how to use the method when you start an . + The following example shows how to use the method when you start an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationService/Overview/Window1.xaml.cs" id="Snippetdocviewxmlstartannotations"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationService/Overview/window1.xaml.vb" id="Snippetdocviewxmlstartannotations"::: @@ -560,7 +560,7 @@ method can be used to return the associated with the following document viewing controls: + The method can be used to return the associated with the following document viewing controls: - @@ -572,7 +572,7 @@ - - The viewer control associated with the annotation service is specified in the parameter to the constructor. + The viewer control associated with the annotation service is specified in the parameter to the constructor. ]]> @@ -613,7 +613,7 @@ method can be used to return the associated with the following document viewing controls: + The method can be used to return the associated with the following document viewing controls: - @@ -625,7 +625,7 @@ - - The viewer control associated with the annotation service is specified in the parameter to the constructor. + The viewer control associated with the annotation service is specified in the parameter to the constructor. ]]> @@ -668,7 +668,7 @@ method can be used to return the associated with the following document viewing controls: + The method can be used to return the associated with the following document viewing controls: - @@ -680,7 +680,7 @@ - - The viewer control associated with the annotation service is specified in the parameter to the constructor. + The viewer control associated with the annotation service is specified in the parameter to the constructor. ]]> @@ -725,7 +725,7 @@ method can be used to return the associated with the following document viewing controls: + The method can be used to return the associated with the following document viewing controls: - @@ -737,7 +737,7 @@ - - The viewer control associated with the annotation service is specified in the parameter to the constructor. + The viewer control associated with the annotation service is specified in the parameter to the constructor. ]]> @@ -831,7 +831,7 @@ used by the is specified as a parameter in the service's method. + The used by the is specified as a parameter in the service's method. diff --git a/xml/System.Windows.Annotations/ContentLocator.xml b/xml/System.Windows.Annotations/ContentLocator.xml index 6c3b684e5eb..f32420ffa90 100644 --- a/xml/System.Windows.Annotations/ContentLocator.xml +++ b/xml/System.Windows.Annotations/ContentLocator.xml @@ -101,11 +101,11 @@ method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . + This method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . The cloned 's property will be `false` even if this source 's property was `true`. - When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or the current animation values. + When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or the current animation values. ]]> @@ -145,7 +145,7 @@ method is provided to fulfill the contract of the interface. + The method is provided to fulfill the contract of the interface. ]]> @@ -269,9 +269,9 @@ returns `true` the starting sequence of elements in this matches those in the specified `locator`. + returns `true` the starting sequence of elements in this matches those in the specified `locator`. - returns `false` if the specified `locator` contains elements that are different, in a different order, or more than in this . + returns `false` if the specified `locator` contains elements that are different, in a different order, or more than in this . ]]> diff --git a/xml/System.Windows.Annotations/ContentLocatorBase.xml b/xml/System.Windows.Annotations/ContentLocatorBase.xml index fccf809f2b2..37869432619 100644 --- a/xml/System.Windows.Annotations/ContentLocatorBase.xml +++ b/xml/System.Windows.Annotations/ContentLocatorBase.xml @@ -70,11 +70,11 @@ method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . + This method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . The cloned 's property will be `false` even if this source 's property is `true`. - When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. + When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. ]]> diff --git a/xml/System.Windows.Annotations/ContentLocatorGroup.xml b/xml/System.Windows.Annotations/ContentLocatorGroup.xml index 6eeeeea894f..8fdeab2f97d 100644 --- a/xml/System.Windows.Annotations/ContentLocatorGroup.xml +++ b/xml/System.Windows.Annotations/ContentLocatorGroup.xml @@ -99,11 +99,11 @@ method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . + This method creates modifiable copies of frozen objects. For convenience, shadows the inherited version with a strongly typed implementation. For more details, see . The cloned 's property will be `false` even if this source 's property is `true`. - When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. + When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. ]]> @@ -143,7 +143,7 @@ is provided to fulfill the contract of the interface. + is provided to fulfill the contract of the interface. ]]> diff --git a/xml/System.Windows.Annotations/ContentLocatorPart.xml b/xml/System.Windows.Annotations/ContentLocatorPart.xml index a5fc9e71f87..d4796569999 100644 --- a/xml/System.Windows.Annotations/ContentLocatorPart.xml +++ b/xml/System.Windows.Annotations/ContentLocatorPart.xml @@ -92,11 +92,11 @@ method creates modifiable copies of frozen objects. For convenience, this method shadows the inherited version with a strongly typed implementation. For more details, see . + This method creates modifiable copies of frozen objects. For convenience, this method shadows the inherited version with a strongly typed implementation. For more details, see . The cloned 's property will be `false` even if this source 's property is `true`. - When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. + When copying dependency properties, copies resource references and data bindings (although they might no longer resolve) but does not copy not animations or current animation values. ]]> @@ -238,7 +238,7 @@ constructor. + The returned type name and namespace is originally defined in the parameter to the constructor. ]]> diff --git a/xml/System.Windows.Annotations/TextAnchor.xml b/xml/System.Windows.Annotations/TextAnchor.xml index d81d56e1156..53d8000b221 100644 --- a/xml/System.Windows.Annotations/TextAnchor.xml +++ b/xml/System.Windows.Annotations/TextAnchor.xml @@ -24,19 +24,19 @@ Represents a selection of content that an annotation is anchored to. - is the object type of the returned if you are using sticky notes and highlights in flow or fixed documents. - -## Examples - Consider a simple document reader application that has a comments pane. The comments pane might be a list box that displays the text from a list of annotations that are anchored to a document. If the user selects an item in the list box, then the application brings into view the paragraph in the document that the corresponding annotation object is anchored to. - - The following example demonstrates how to implement the event handler of such a list box that serves as the comments pane. - + is the object type of the returned if you are using sticky notes and highlights in flow or fixed documents. + +## Examples + Consider a simple document reader application that has a comments pane. The comments pane might be a list box that displays the text from a list of annotations that are anchored to a document. If the user selects an item in the list box, then the application brings into view the paragraph in the document that the corresponding annotation object is anchored to. + + The following example demonstrates how to implement the event handler of such a list box that serves as the comments pane. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationHelper/GetAnchorInfo/Window1.xaml.cs" id="Snippethandler"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationHelper/GetAnchorInfo/window1.xaml.vb" id="Snippethandler"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationHelper/GetAnchorInfo/window1.xaml.vb" id="Snippethandler"::: + ]]> @@ -101,16 +101,16 @@ Gets the beginning position of the text anchor. The beginning position of the text anchor. - diff --git a/xml/System.Windows.Automation.Peers/AutomationEvents.xml b/xml/System.Windows.Automation.Peers/AutomationEvents.xml index 3f13fcabbb6..84346376e9b 100644 --- a/xml/System.Windows.Automation.Peers/AutomationEvents.xml +++ b/xml/System.Windows.Automation.Peers/AutomationEvents.xml @@ -23,11 +23,11 @@ Specifies the event that is raised by the element through the associated . - method to raise an event. - + method to raise an event. + ]]> diff --git a/xml/System.Windows.Automation.Peers/AutomationPeer.xml b/xml/System.Windows.Automation.Peers/AutomationPeer.xml index 364f9ba3e79..8471235f69a 100644 --- a/xml/System.Windows.Automation.Peers/AutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/AutomationPeer.xml @@ -879,7 +879,7 @@ In addition to overriding this method, the types that are associated with an element that immediately hosts an `hwnd` must return the that is cast to in response to WM_GETOBJECT coming to the hosted `hwnd`. - To get a pointer to , call . + To get a pointer to , call . ]]> @@ -1058,13 +1058,13 @@ control, the method gets the for the that is associated with the . + For example, if the element is a control, the method gets the for the that is associated with the . - In the following image, the "Themes" is targeted to the ; therefore the for the also targets the . When the user presses **ALT**+**T**, the gets focus instead of the . + In the following image, the "Themes" is targeted to the ; therefore the for the also targets the . When the user presses **ALT**+**T**, the gets focus instead of the . ![Display properties shows labeled by usage](~/add/media/labeledby.JPG "Display properties shows labeled by usage") - The method for returns the for the corresponding . This enables an automation client to get the text string that describes the . + The method for returns the for the corresponding . This enables an automation client to get the text string that describes the . ]]> @@ -1267,7 +1267,7 @@ This method calls the derived implementation of . + This method calls the derived implementation of . ]]> @@ -1728,9 +1728,9 @@ This method calls the derived implementation of and . + Examples of main properties include, but are not limited to, and . - Typically, updates and notifications happen automatically after the update of the layout in Windows Presentation Foundation (WPF). (The update occurs in response to the event.) Sometimes, however, properties change without raising the event. For example, when the whole moves, the event is not raised. In this example, the set of objects change because the objects are expressed in screen coordinates. Therefore, the must call on its peer on . + Typically, updates and notifications happen automatically after the update of the layout in Windows Presentation Foundation (WPF). (The update occurs in response to the event.) Sometimes, however, properties change without raising the event. For example, when the whole moves, the event is not raised. In this example, the set of objects change because the objects are expressed in screen coordinates. Therefore, the must call on its peer on . ]]> @@ -2035,7 +2035,7 @@ This method calls the derived implementation of and . - These peers must also override . + These peers must also override . ]]> diff --git a/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml b/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml index 4c6e9ecda96..9fd940a3ebf 100644 --- a/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml @@ -91,7 +91,7 @@ ## Remarks This remains in memory until the associated is destroyed. - The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. + The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. ]]> @@ -565,7 +565,7 @@ control, the method could get the for the that is associated with the . + For example, if the element is a control, the method could get the for the that is associated with the . ]]> diff --git a/xml/System.Windows.Automation.Peers/DocumentAutomationPeer.xml b/xml/System.Windows.Automation.Peers/DocumentAutomationPeer.xml index 1ede9c11664..208cd7192c4 100644 --- a/xml/System.Windows.Automation.Peers/DocumentAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/DocumentAutomationPeer.xml @@ -27,10 +27,10 @@ represents documents and supports the . Objects such as a or can contain embedded objects, such as images and hyperlinks. Initially, when you try to get the child elements of the document, does not return the embedded objects. To get the embedded elements, obtain a from the and call . After is called, any elements in that are returned by . + The represents documents and supports the . Objects such as a or can contain embedded objects, such as images and hyperlinks. Initially, when you try to get the child elements of the document, does not return the embedded objects. To get the embedded elements, obtain a from the and call . After is called, any elements in that are returned by . > [!NOTE] -> Unless you know the document is a , you should not call on the property. If the document is loaded from a network location, calling on the entire document is resource intensive. Instead, you should use one of the methods on that returns a that represents a portion of the document. +> Unless you know the document is a , you should not call on the property. If the document is loaded from a network location, calling on the entire document is resource intensive. Instead, you should use one of the methods on that returns a that represents a portion of the document. ]]> diff --git a/xml/System.Windows.Automation.Peers/FlowDocumentScrollViewerAutomationPeer.xml b/xml/System.Windows.Automation.Peers/FlowDocumentScrollViewerAutomationPeer.xml index 3ce6b812226..c2d6d9ed7ff 100644 --- a/xml/System.Windows.Automation.Peers/FlowDocumentScrollViewerAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/FlowDocumentScrollViewerAutomationPeer.xml @@ -183,17 +183,17 @@ Gets the control pattern for the that is associated with this . An object that supports the control pattern if is a supported value; otherwise, . - method returns when depending on the value of `patternInterface`: - -|The value of `patternInterface`|The return value| -|-------------------------------------|----------------------| -||The for this .| -||An object that implements the interface.| -||An object that implements the interface.| - + method returns when depending on the value of `patternInterface`: + +|The value of `patternInterface`|The return value| +|-------------------------------------|----------------------| +||The for this .| +||An object that implements the interface.| +||An object that implements the interface.| + ]]> diff --git a/xml/System.Windows.Automation.Peers/FrameworkContentElementAutomationPeer.xml b/xml/System.Windows.Automation.Peers/FrameworkContentElementAutomationPeer.xml index d2079b58f58..bc6d7af2f07 100644 --- a/xml/System.Windows.Automation.Peers/FrameworkContentElementAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/FrameworkContentElementAutomationPeer.xml @@ -120,11 +120,11 @@ Gets the string that describes the functionality of the that is associated with this . This method is called by . The string describing the functionality of the element. - @@ -158,11 +158,11 @@ Gets the for the that is targeted to the that is associated with this . This method is called by . The for the element that is targeted by the . - control, the method can retrieve the for the that is associated with the . - + control, the method can retrieve the for the that is associated with the . + ]]> diff --git a/xml/System.Windows.Automation.Peers/ItemAutomationPeer.xml b/xml/System.Windows.Automation.Peers/ItemAutomationPeer.xml index ced1790c3c9..922b153daae 100644 --- a/xml/System.Windows.Automation.Peers/ItemAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/ItemAutomationPeer.xml @@ -114,7 +114,7 @@ . + This method is called by . ]]> @@ -152,7 +152,7 @@ . + This method is called by . ]]> @@ -192,7 +192,7 @@ ## Remarks The value of the UI Automation identifier is the property. If the property is not set, the value is the property. - This method is called by . + This method is called by . ]]> @@ -230,7 +230,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -268,7 +268,7 @@ . + This method is called by . ]]> @@ -306,7 +306,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -372,7 +372,7 @@ . + This method is called by . ]]> @@ -410,7 +410,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -448,7 +448,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -486,7 +486,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -555,7 +555,7 @@ ## Remarks You can think of the name property as if it were a string of text that users use to explain which control they are referring to. Make certain that you have a textual representation for all controls in the graphical user interface (GUI) so that you can programmatically refer to the control in a localized manner. - This method is called by . + This method is called by . ]]> @@ -593,7 +593,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -729,7 +729,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -768,7 +768,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -807,7 +807,7 @@ corresponds to the data item in the collection. The user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . + The corresponds to the data item in the collection. The user might understand the as contributing to the logical structure of the control in the GUI. This method is called by . ]]> @@ -874,7 +874,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -913,7 +913,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -952,7 +952,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . This method does not indicate whether the element is visible. In some circumstances, an element is on the screen but is still not visible. For example, if the element is obscured by other elements, it might not be visible. In this case, the method returns `false`. @@ -993,7 +993,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -1032,7 +1032,7 @@ corresponds to the data item in the collection that is associated with this . This method is called by . + The corresponds to the data item in the collection that is associated with this . This method is called by . ]]> @@ -1143,7 +1143,7 @@ . + This method is called by . ]]> diff --git a/xml/System.Windows.Automation.Peers/RibbonAutomationPeer.xml b/xml/System.Windows.Automation.Peers/RibbonAutomationPeer.xml index d6fa86dca53..b022b505402 100644 --- a/xml/System.Windows.Automation.Peers/RibbonAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/RibbonAutomationPeer.xml @@ -258,7 +258,7 @@ method returns a collection of objects that represent the , , and objects that belong to the . + The method returns a collection of objects that represent the , , and objects that belong to the . ]]> diff --git a/xml/System.Windows.Automation.Peers/TextBoxAutomationPeer.xml b/xml/System.Windows.Automation.Peers/TextBoxAutomationPeer.xml index 593aee155d8..c051b1226c2 100644 --- a/xml/System.Windows.Automation.Peers/TextBoxAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/TextBoxAutomationPeer.xml @@ -158,18 +158,18 @@ Gets the control pattern for the that is associated with this . An object that supports the control pattern if is a supported value; otherwise, . - method returns when depending on the value of `patternInterface`: - -|The value of `patternInterface`|The return value| -|-------------------------------------|----------------------| -||A reference to the current instance of the .| -||The for this .| -||An object that implements the interface.| -||An object that implements the interface.| - + method returns when depending on the value of `patternInterface`: + +|The value of `patternInterface`|The return value| +|-------------------------------------|----------------------| +||A reference to the current instance of the .| +||The for this .| +||An object that implements the interface.| +||An object that implements the interface.| + ]]> UI Automation Control Patterns diff --git a/xml/System.Windows.Automation.Peers/TreeViewDataItemAutomationPeer.xml b/xml/System.Windows.Automation.Peers/TreeViewDataItemAutomationPeer.xml index 2f4d1b6bd25..cc85760b258 100644 --- a/xml/System.Windows.Automation.Peers/TreeViewDataItemAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/TreeViewDataItemAutomationPeer.xml @@ -157,19 +157,19 @@ Gets the control pattern for the element that is associated with this . The object that implements the pattern interface, or if the specified pattern interface is not implemented by this peer. - method returns when depending on the value of `patternInterface`: - -|The value of `patternInterface`|The return value| -|-------------------------------------|----------------------| -||The current .| -||The that represents the that contains the data item| -||The current .| -||The current .| -||An object that implements the interface.| - + method returns when depending on the value of `patternInterface`: + +|The value of `patternInterface`|The return value| +|-------------------------------------|----------------------| +||The current .| +||The that represents the that contains the data item| +||The current .| +||The current .| +||An object that implements the interface.| + ]]> @@ -237,11 +237,11 @@ Hides all nodes, controls, or content that are descendants of the control. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -275,11 +275,11 @@ Displays all child nodes, controls, or content of the control. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -313,11 +313,11 @@ Gets the state, expanded or collapsed, of the control. The state, expanded or collapsed, of the control. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -351,11 +351,11 @@ Scrolls the content area of a container object in order to display the control within the visible region (viewport) of the container. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -389,11 +389,11 @@ Adds the current element to the collection of selected items. - instance is cast to an interface. - + instance is cast to an interface. + ]]> UI Automation element is no longer available. @@ -429,11 +429,11 @@ if an item is selected; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -467,11 +467,11 @@ Removes the current element from the collection of selected items. - instance is cast to an interface. - + instance is cast to an interface. + ]]> UI Automation element is no longer available. @@ -506,11 +506,11 @@ Clears any selection and then selects the current element. - instance is cast to an interface. - + instance is cast to an interface. + ]]> UI Automation element is no longer available. @@ -545,11 +545,11 @@ Gets the UI automation provider that implements and acts as the container for the calling object. The UI automation provider. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml b/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml index 409def7f7cf..db260f4c915 100644 --- a/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml @@ -29,9 +29,9 @@ ## Remarks By default, any class that inherits from uses to communicate with UI Automation. - If you create a class that inherits from , you may want to provide an automation peer to support the functionality of your class. Override the method to return a string that represents the type of the element associated with the . For example, if you create a class called `My3DElement` and an automation peer called `My3DElementAutomationPeer`, override the method to return the string "My3DElement". + If you create a class that inherits from , you may want to provide an automation peer to support the functionality of your class. Override the method to return a string that represents the type of the element associated with the . For example, if you create a class called `My3DElement` and an automation peer called `My3DElementAutomationPeer`, override the method to return the string "My3DElement". - If your class matches one of the known control types, override the method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . + If your class matches one of the known control types, override the method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . The behavior of your custom determines what other methods you should override. Each method topic in the describes how the method is used and when it is appropriate to override it. @@ -113,7 +113,7 @@ ## Remarks This remains in memory until the associated is destroyed. - The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. + The same instance of the is returned from subsequent calls to this method and to calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created and this method returns `null`. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -192,7 +192,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide the accelerator key in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the accelerator key in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -231,7 +231,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide the access key in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the access key in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -272,7 +272,7 @@ method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . + If your class matches one of the known control types, override the method to return that . Note that although the existing values are generally associated with 2D controls, the indicates a control's functionality, not its appearance. So if your invokes an action when the user clicks it, you probably want to return . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -311,7 +311,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide an identifier in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide an identifier in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -350,9 +350,9 @@ and a , this method returns . + If the element is not both a and a , this method returns . - Classes that inherit from typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -391,7 +391,7 @@ typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -470,7 +470,7 @@ method returns the point that represents the center of the . Override if you want to return a different point. + The method returns the point that represents the center of the . Override if you want to return a different point. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -537,7 +537,7 @@ method returns a string that is the same text that the control provides in the tooltip. This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the help text in a way that makes sense for your . + Typically, the method returns a string that is the same text that the control provides in the tooltip. This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the help text in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -578,7 +578,7 @@ ## Remarks Return a string that indicates whether the is conveying status about an item. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected". - This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the item status in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the item status in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -617,7 +617,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide the item type in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the item type in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -656,7 +656,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide the in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide the in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -726,7 +726,7 @@ ## Remarks You can think of the name property as what users use to explain the control they are referring to. Be sure to have a textual representation for all controls in the graphical user interface (GUI) so that you can programmatically refer to the control in a localized manner. - This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide a name in a way that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide a name in a way that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -808,7 +808,7 @@ method to return control patterns that apply to your . For more information, see [UI Automation Control Patterns Overview](/dotnet/framework/ui-automation/ui-automation-control-patterns-overview). + Override the method to return control patterns that apply to your . For more information, see [UI Automation Control Patterns Overview](/dotnet/framework/ui-automation/ui-automation-control-patterns-overview). is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -906,7 +906,7 @@ typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -946,7 +946,7 @@ method if your is not a content element. A content element contains data that is presented to the user. An example of a content element is an item in a list box or a button on a dialog box. You typically use non-content elements, which are also called peripheral elements, to manipulate the content in a composite control. An example of a non-content element is the button on a drop-down control. + Override the method if your is not a content element. A content element contains data that is presented to the user. An example of a content element is an item in a list box or a button on a dialog box. You typically use non-content elements, which are also called peripheral elements, to manipulate the content in a composite control. An example of a non-content element is the button on a drop-down control. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1054,7 +1054,7 @@ typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1094,7 +1094,7 @@ typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1136,7 +1136,7 @@ ## Remarks This property does not indicate whether the element is visible. In some circumstances, an element is on the screen but is still not visible. For example, if the element is on the screen but obscured by other elements, it might not be visible. In this case the method returns `false`. - Classes that inherit from typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1176,7 +1176,7 @@ if your contains protected content, such as a password. + Override if your contains protected content, such as a password. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1216,7 +1216,7 @@ method to get the value. returns a value only when the property is set. You can override and add logic to provide a value that makes sense for your . + This method calls the method to get the value. returns a value only when the property is set. You can override and add logic to provide a value that makes sense for your . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1296,7 +1296,7 @@ typically do not need to override . + Classes that inherit from typically do not need to override . is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). diff --git a/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml b/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml index 3c9ecf18e96..7c07a10ef99 100644 --- a/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml +++ b/xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml @@ -91,7 +91,7 @@ ## Remarks This remains in memory until the associated is destroyed. - The same instance of the is returned from subsequent calls to this method and calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created, and this method returns `null`. + The same instance of the is returned from subsequent calls to this method and calls to . The type of the peer is determined by the virtual callback. If does not implement the callback, no is created, and this method returns `null`. ]]> diff --git a/xml/System.Windows.Automation.Provider/AutomationInteropProvider.xml b/xml/System.Windows.Automation.Provider/AutomationInteropProvider.xml index 87c7f84b8a3..d6f373f98cc 100644 --- a/xml/System.Windows.Automation.Provider/AutomationInteropProvider.xml +++ b/xml/System.Windows.Automation.Provider/AutomationInteropProvider.xml @@ -53,19 +53,19 @@ Contains a value that, when returned as the first element of the array passed by the UI Automation provider to , indicates that the ID is partial and should be appended to the ID provided by the base provider. - for elements in a fragment that are not directly hosted in a window. - - - -## Examples - The following example is an implementation of for a list item. - + for elements in a fragment that are not directly hosted in a window. + + + +## Examples + The following example is an implementation of for a list item. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AutomationEventArgs/.ctor/ListItemFragment.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListItemFragment.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListItemFragment.vb" id="Snippet101"::: + ]]> @@ -98,12 +98,12 @@ if a client is subscribed to events; otherwise . - Raise Events from a UI Automation Provider @@ -141,17 +141,17 @@ Returns a UI Automation provider that represents the specified window. The raw element provider for the specified window. - @@ -183,11 +183,11 @@ Specifies the maximum number of events to send before batching. - or of bulk events such as . - + or of bulk events such as . + ]]> @@ -254,17 +254,17 @@ Information about the event. Raises a pattern event or a custom event. - should be raised whenever the control is invoked, either through or through mouse or keyboard input. In this way, clients can be informed about system events. - - - -## Examples + should be raised whenever the control is invoked, either through or through mouse or keyboard input. In this way, clients can be informed about system events. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AutomationEventArgs/.ctor/ListFragment.cs" id="Snippet122"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet122"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet122"::: + ]]> Raise Events from a UI Automation Provider @@ -303,12 +303,12 @@ Information about the event. Raises an event when a UI Automation property has changed. - Raise Events from a UI Automation Provider @@ -347,23 +347,23 @@ Information about the event. Raises an event when the UI Automation tree has changed. - constructor. In the current version of UI Automation, however, there is no easy way for an instance of a provider to discover its runtime identifier. The method normally returns an array that contains , a magic number that instructs the UI Automation system to create a unique identifer for every instance of the control. The raw value provided by should not be used in events, because it is meaningless to clients and cannot be used to identify a specific instance. - - Because of this limitation, events of type and are not very useful. As an alternative, always use and , passing 0 as the runtime identifer. You cannot use `null`, as this will raise an exception. Clients will be notified that a change has been made in the container (identified by the `sender` parameter passed to the ), without specific notice of what children have been added or removed. - - - -## Examples - The following example shows how to raise an event when children are added to, or removed from, a custom list box. - + constructor. In the current version of UI Automation, however, there is no easy way for an instance of a provider to discover its runtime identifier. The method normally returns an array that contains , a magic number that instructs the UI Automation system to create a unique identifer for every instance of the control. The raw value provided by should not be used in events, because it is meaningless to clients and cannot be used to identify a specific instance. + + Because of this limitation, events of type and are not very useful. As an alternative, always use and , passing 0 as the runtime identifer. You cannot use `null`, as this will raise an exception. Clients will be notified that a change has been made in the container (identified by the `sender` parameter passed to the ), without specific notice of what children have been added or removed. + + + +## Examples + The following example shows how to raise an event when children are added to, or removed from, a custom list box. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/StructureChangedEventArgs/.ctor/ListFragment.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/FragmentProvider/VisualBasic/ListFragment.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/FragmentProvider/VisualBasic/ListFragment.vb" id="Snippet101"::: + ]]> @@ -408,12 +408,12 @@ Returns the UI automation provider for an element in response to a message. A pointer to data that should be assigned to before passing the message to the base window procedure. - Expose a UI Automation Provider diff --git a/xml/System.Windows.Automation.Provider/IGridProvider.xml b/xml/System.Windows.Automation.Provider/IGridProvider.xml index 30fb595969a..e74bf18b625 100644 --- a/xml/System.Windows.Automation.Provider/IGridProvider.xml +++ b/xml/System.Windows.Automation.Provider/IGridProvider.xml @@ -83,7 +83,7 @@ and properties. If the hidden rows and columns have not yet been loaded they will not be counted. + Hidden rows and columns, depending on the provider implementation, can be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they will not be counted. @@ -142,7 +142,7 @@ ![Windows Explorer view showing ragged layout.](~/add/media/uia-gridpattern-ragged-array.PNG "Windows Explorer view showing ragged layout.") Example of a Grid Control with Empty Coordinates -- Hidden rows and columns, depending on the provider implementation, can be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they should not be counted. +- Hidden rows and columns, depending on the provider implementation, can be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they should not be counted. @@ -187,7 +187,7 @@ Example of a Grid Control with Empty Coordinates and properties. If the hidden rows and columns have not yet been loaded they will not be counted. + Hidden rows and columns, depending on the provider implementation, can be loaded in the logical tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they will not be counted. diff --git a/xml/System.Windows.Automation.Provider/IInvokeProvider.xml b/xml/System.Windows.Automation.Provider/IInvokeProvider.xml index 6e85424edb8..9d2d9aeb563 100644 --- a/xml/System.Windows.Automation.Provider/IInvokeProvider.xml +++ b/xml/System.Windows.Automation.Provider/IInvokeProvider.xml @@ -41,7 +41,7 @@ ## Remarks Implemented on a UI Automation provider that must support the control pattern. - Controls implement if the same behavior is not exposed through another control pattern provider. For example, if the method on a control performs the same action as the or method, the control should not implement . + Controls implement if the same behavior is not exposed through another control pattern provider. For example, if the method on a control performs the same action as the or method, the control should not implement . ]]> @@ -83,14 +83,14 @@ is an asynchronous call and must return immediately without blocking. + is an asynchronous call and must return immediately without blocking. > [!NOTE] > This behavior is particularly critical for controls that, directly or indirectly, launch a modal dialog when invoked. Any UI Automation client that instigated the event will remain blocked until the modal dialog is closed. - raises the event. If possible, the event should be raised after the control has completed its associated action. + raises the event. If possible, the event should be raised after the control has completed its associated action. - should be raised before servicing the request in the following scenarios: + should be raised before servicing the request in the following scenarios: - It is not possible or practical to wait until the action is complete. @@ -101,7 +101,7 @@ ## Examples - The following example implements the method on the MouseDown event handler of a control. Assume that `providerControl` is a member variable that was initialized when the class was constructed. + The following example implements the method on the MouseDown event handler of a control. Assume that `providerControl` is a member variable that was initialized when the class was constructed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/Invoker.cs" id="Snippet106"::: diff --git a/xml/System.Windows.Automation.Provider/IMultipleViewProvider.xml b/xml/System.Windows.Automation.Provider/IMultipleViewProvider.xml index 1a966f7462f..710f41359b0 100644 --- a/xml/System.Windows.Automation.Provider/IMultipleViewProvider.xml +++ b/xml/System.Windows.Automation.Provider/IMultipleViewProvider.xml @@ -36,11 +36,11 @@ Exposes methods and properties to support UI Automation client access to controls that provide, and are able to switch between, multiple representations of the same set of information or child controls. - control pattern. - + control pattern. + ]]> @@ -78,11 +78,11 @@ Gets the current control-specific view. The value for the current view of the UI Automation element. - Implementing the UI Automation MultipleView Control Pattern @@ -116,13 +116,13 @@ Retrieves a collection of control-specific view identifiers. A collection of values that identifies the views available for a UI Automation element. - . - + . + ]]> Implementing the UI Automation MultipleView Control Pattern @@ -159,15 +159,15 @@ Retrieves the name of a control-specific view. A localized name for the view. - . - - The collection of view identifiers must be identical across instances. - - View names must be suitable for use in text-to-speech, Braille, and other accessible applications. - + . + + The collection of view identifiers must be identical across instances. + + View names must be suitable for use in text-to-speech, Braille, and other accessible applications. + ]]> @@ -205,13 +205,13 @@ A view identifier. Sets the current control-specific view. - . - - The collection of view identifiers must be identical across instances. - + . + + The collection of view identifiers must be identical across instances. + ]]> diff --git a/xml/System.Windows.Automation.Provider/IRawElementProviderAdviseEvents.xml b/xml/System.Windows.Automation.Provider/IRawElementProviderAdviseEvents.xml index f049f5cb188..5e46ed739a6 100644 --- a/xml/System.Windows.Automation.Provider/IRawElementProviderAdviseEvents.xml +++ b/xml/System.Windows.Automation.Provider/IRawElementProviderAdviseEvents.xml @@ -75,21 +75,21 @@ The identifiers of the properties being added, or if the event listener being added is not listening for property events. Notifies the UI Automation provider when a UI Automation client begins listening for a specific event, including a property-changed event. - of an such as . You can also obtain the by using . - - - -## Examples - The following example adds to a list of property changes that have been subscribed to. - + of an such as . You can also obtain the by using . + + + +## Examples + The following example adds to a list of property changes that have been subscribed to. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AutomationEventArgs/.ctor/ListFragment.cs" id="Snippet124"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet124"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet124"::: + ]]> @@ -126,21 +126,21 @@ The identifiers of the properties being removed, or if the event listener being removed is not listening for property events. Notifies the UI Automation provider when a UI Automation client stops listening for a specific event, including a property-changed event. - of an such as . You can also obtain the by using . - - - -## Examples - The following example removes property changes from a list of those that have been subscribed to. - + of an such as . You can also obtain the by using . + + + +## Examples + The following example removes property changes from a list of those that have been subscribed to. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AutomationEventArgs/.ctor/ListFragment.cs" id="Snippet125"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet125"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet125"::: + ]]> diff --git a/xml/System.Windows.Automation.Provider/IRawElementProviderFragment.xml b/xml/System.Windows.Automation.Provider/IRawElementProviderFragment.xml index 5a49b34e317..2266fcb8cad 100644 --- a/xml/System.Windows.Automation.Provider/IRawElementProviderFragment.xml +++ b/xml/System.Windows.Automation.Provider/IRawElementProviderFragment.xml @@ -277,7 +277,7 @@ ## Examples - The following example code shows the implementation of by a fragment root that has a single child element. Because the implementing element is a fragment root, it does not enable navigation to a parent element or sibling elements. + The following example code shows the implementation of by a fragment root that has a single child element. Because the implementing element is a fragment root, it does not enable navigation to a parent element or sibling elements. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/FragmentRoot.cs" id="Snippet105"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAProvider_snip/VisualBasic/FragmentRoot.vb" id="Snippet105"::: diff --git a/xml/System.Windows.Automation.Provider/IRawElementProviderSimple.xml b/xml/System.Windows.Automation.Provider/IRawElementProviderSimple.xml index f131d51229e..332596a96de 100644 --- a/xml/System.Windows.Automation.Provider/IRawElementProviderSimple.xml +++ b/xml/System.Windows.Automation.Provider/IRawElementProviderSimple.xml @@ -103,7 +103,7 @@ for a provider that supports only . + The following example shows an implementation of for a provider that supports only . :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/FragmentRoot.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAProvider_snip/VisualBasic/FragmentRoot.vb" id="Snippet101"::: @@ -157,7 +157,7 @@ ## Examples - The following code example shows an implementation of for a custom button control. + The following code example shows an implementation of for a custom button control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/FragmentRoot.cs" id="Snippet102"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAProvider_snip/VisualBasic/FragmentRoot.vb" id="Snippet102"::: @@ -217,7 +217,7 @@ ## Examples - The following example code shows an implementation of for a fragment root that is hosted in a Windows form. + The following example code shows an implementation of for a fragment root that is hosted in a Windows form. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/FragmentRoot.cs" id="Snippet103"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAProvider_snip/VisualBasic/FragmentRoot.vb" id="Snippet103"::: @@ -267,7 +267,7 @@ ## Examples - The following example code shows an implementation of for a server-side UI Automation provider. + The following example code shows an implementation of for a server-side UI Automation provider. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IInvokeProvider/Invoke/FragmentRoot.cs" id="Snippet104"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAProvider_snip/VisualBasic/FragmentRoot.vb" id="Snippet104"::: diff --git a/xml/System.Windows.Automation.Provider/IScrollProvider.xml b/xml/System.Windows.Automation.Provider/IScrollProvider.xml index 2cadb89f33d..6ac81d0ea75 100644 --- a/xml/System.Windows.Automation.Provider/IScrollProvider.xml +++ b/xml/System.Windows.Automation.Provider/IScrollProvider.xml @@ -36,11 +36,11 @@ Exposes methods and properties to support UI Automation client access to a control that acts as a scrollable container for a collection of child objects. The children of this control must implement . - control pattern. - + control pattern. + ]]> @@ -79,11 +79,11 @@ if the control can scroll horizontally; otherwise . - is `false`. However, either resizing the control or adding child items can increase the bounds of the content area beyond the viewable area, meaning that is `true`. - + is `false`. However, either resizing the control or adding child items can increase the bounds of the content area beyond the viewable area, meaning that is `true`. + ]]> Implementing the UI Automation Scroll Control Pattern @@ -218,13 +218,13 @@ The vertical position as a percentage of the content area's total range. should be passed in if the control cannot be scrolled in this direction. Sets the horizontal and vertical scroll position as a percentage of the total content area within the control. - indicates that there is no scrolling in the specified direction. - + indicates that there is no scrolling in the specified direction. + ]]> A value that cannot be converted to a double is passed in. @@ -261,11 +261,11 @@ if the control can scroll vertically; otherwise . - is `false`. However, resizing the control or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. - + is `false`. However, resizing the control or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. + ]]> Implementing the UI Automation Scroll Control Pattern diff --git a/xml/System.Windows.Automation.Provider/ISelectionItemProvider.xml b/xml/System.Windows.Automation.Provider/ISelectionItemProvider.xml index 2ccc0ef256d..498368dfbf7 100644 --- a/xml/System.Windows.Automation.Provider/ISelectionItemProvider.xml +++ b/xml/System.Windows.Automation.Provider/ISelectionItemProvider.xml @@ -82,7 +82,7 @@ is that a single item is selected, then send an for that element; otherwise send an or as appropriate. + If the result of a call to is that a single item is selected, then send an for that element; otherwise send an or as appropriate. > [!NOTE] > This rule does not depend on whether the container allows single or multiple selections, or on what method was used to change the selection. Only the result matters. diff --git a/xml/System.Windows.Automation.Provider/ISelectionProvider.xml b/xml/System.Windows.Automation.Provider/ISelectionProvider.xml index cdcb60bb039..214a68f99dd 100644 --- a/xml/System.Windows.Automation.Provider/ISelectionProvider.xml +++ b/xml/System.Windows.Automation.Provider/ISelectionProvider.xml @@ -36,11 +36,11 @@ Exposes methods and properties to support UI Automation client access to controls that act as containers for a collection of individual, selectable child items. The children of this control must implement . - control pattern. - + control pattern. + ]]> @@ -80,19 +80,19 @@ if multiple selection is allowed; otherwise . - Implementing the UI Automation Selection Control Pattern @@ -127,19 +127,19 @@ Retrieves a UI Automation provider for each child element that is selected. A collection of UI Automation providers. - Implementing the UI Automation Selection Control Pattern @@ -174,19 +174,19 @@ if selection is required; otherwise . - is `false`. However, after an item is selected, the control must always have at least one item selected. - - - -## Examples - The following example shows an implementation of this method for a list that requires an item to be selected at all times. - + is `false`. However, after an item is selected, the control must always have at least one item selected. + + + +## Examples + The following example shows an implementation of this method for a list that requires an item to be selected at all times. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ISelectionItemProvider/AddToSelection/ListFragment.cs" id="Snippetisselectionrequired"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAISelectionProvider_ISelectionItemProvider_snip/visualbasic/listfragment.vb" id="Snippetisselectionrequired"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAISelectionProvider_ISelectionItemProvider_snip/visualbasic/listfragment.vb" id="Snippetisselectionrequired"::: + ]]> Implementing the UI Automation Selection Control Pattern diff --git a/xml/System.Windows.Automation.Provider/ITextProvider.xml b/xml/System.Windows.Automation.Provider/ITextProvider.xml index e172258b1ca..83156409cfa 100644 --- a/xml/System.Windows.Automation.Provider/ITextProvider.xml +++ b/xml/System.Windows.Automation.Provider/ITextProvider.xml @@ -36,11 +36,11 @@ Exposes methods and properties to support UI Automation client access to controls that contain text. - control pattern. - + control pattern. + ]]> @@ -78,11 +78,11 @@ Gets a text range that encloses the main text of a document. To be added. - @@ -116,15 +116,15 @@ Retrieves a collection of disjoint text ranges associated with the current text selection or selections. A collection of disjoint text ranges. - value. - - If no text is selected, returns the degenerate text range (empty range) at the position of the system cursor (text insertion point). - - If the system cursor (text insertion point) is not present, may return a null reference (`Nothing` in Visual Basic). - + value. + + If no text is selected, returns the degenerate text range (empty range) at the position of the system cursor (text insertion point). + + If the system cursor (text insertion point) is not present, may return a null reference (`Nothing` in Visual Basic). + ]]> If the UI Automation provider does not support text selection. @@ -159,15 +159,15 @@ Retrieves an array of disjoint text ranges from a text container where each text range begins with the first partially visible line through to the end of the last partially visible line. The collection of visible text ranges within the container or an empty array. A null reference ( in Visual Basic) is never returned. - @@ -204,15 +204,15 @@ Retrieves a text range enclosing a child element such as an image, hyperlink, or other embedded object. A range that spans the child element. - associated with a or from the array of children of a . - + associated with a or from the array of children of a . + ]]> If the child element is a null reference ( in Visual Basic). @@ -250,13 +250,13 @@ Returns the degenerate (empty) text range nearest to the specified screen coordinates. A degenerate range nearest the specified location. A null reference ( in Visual Basic) is never returned. - a degenerate range from the visible text closest to the given point is returned. - + a degenerate range from the visible text closest to the given point is returned. + ]]> If a given point is outside the UI Automation element associated with the text pattern. diff --git a/xml/System.Windows.Automation.Provider/ITextRangeProvider.xml b/xml/System.Windows.Automation.Provider/ITextRangeProvider.xml index 6d29ce61a29..1acc5534206 100644 --- a/xml/System.Windows.Automation.Provider/ITextRangeProvider.xml +++ b/xml/System.Windows.Automation.Provider/ITextRangeProvider.xml @@ -275,13 +275,13 @@ ## Remarks If the range is already an exact quantity of the specified units then it remains unchanged. - There is a series of steps are involved behind the scenes in order for the method to execute successfully. + There is a series of steps are involved behind the scenes in order for the method to execute successfully. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, which makes the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. -3. The range is moved forward or backward in the by the requested number of `unit` boundaries. +3. The range is moved forward or backward in the by the requested number of `unit` boundaries. 4. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. @@ -291,9 +291,9 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() > [!NOTE] > These steps are necessary since it is common for a screen reader to read out a full word, sentence, or entire paragraph at the insertion point or any virtual cursor position. - respects both hidden and visible text. + respects both hidden and visible text. - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -609,11 +609,11 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() respects both hidden and visible text. + respects both hidden and visible text. If `maxLength` is greater than the length of the text span of the caller, the string returned will be the plain text of the text range. - will not be affected by the order of endpoints in the text flow; it will always return the text between the Start and End endpoints of the text range in the logical text flow order. + will not be affected by the order of endpoints in the text flow; it will always return the text between the Start and End endpoints of the text range in the logical text flow order. ]]> @@ -662,13 +662,13 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() method to execute successfully. + When it is necessary to traverse the content of a text range, a series of steps are involved behind the scenes in order for the method to execute successfully. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, which makes the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. -3. The range is moved forward or backward in the by the requested number of `unit` boundaries. +3. The range is moved forward or backward in the by the requested number of `unit` boundaries. 4. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. @@ -680,9 +680,9 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() ![Text ranges spanned by embedded objects.](~/add/media/uia-textpattern-embeddedobjecttextranges.png "Text ranges spanned by embedded objects.") Example of a text stream with embedded objects and their range spans - respects both hidden and visible text. + respects both hidden and visible text. - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -795,18 +795,18 @@ Example of a text stream with embedded objects and their range spans method to execute successfully. + When it is necessary to traverse the content of a text range, a series of steps are involved behind the scenes in order for the method to execute successfully. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, which makes the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. 3. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. ![Range adjustments by Move & ExpandToEnclosingUnit](~/add/media/uia-textpattern-moveandexpand-examples.png "Range adjustments by Move & ExpandToEnclosingUnit") Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -909,7 +909,7 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() respects both hidden and visible text. + respects both hidden and visible text. If the text range is hidden, the text control will scroll only if the hidden text has an anchor in the viewport. diff --git a/xml/System.Windows.Automation.Provider/IValueProvider.xml b/xml/System.Windows.Automation.Provider/IValueProvider.xml index 341c2c6ec45..65f6708f475 100644 --- a/xml/System.Windows.Automation.Provider/IValueProvider.xml +++ b/xml/System.Windows.Automation.Provider/IValueProvider.xml @@ -36,13 +36,13 @@ Exposes methods and properties to support UI Automation client access to controls having an intrinsic value that does not span a range and that can be represented as a string. - control pattern. - + control pattern. + ]]> @@ -81,19 +81,19 @@ if the value is read-only; if it can be modified. - set to `true` and its set to `false` before allowing a call to . - - - -## Examples - The following example shows an implementation of this method for a control that allows its value to be changed. - + set to `true` and its set to `false` before allowing a call to . + + + +## Examples + The following example shows an implementation of this method for a control that allows its value to be changed. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IValueProvider/IsReadOnly/ValueFragment.cs" id="Snippetisreadonly"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetisreadonly"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetisreadonly"::: + ]]> @@ -128,24 +128,24 @@ The value to set. The provider is responsible for converting the value to the appropriate data type. Sets the value of a control. - . However, multi-line edit controls do not implement ; instead they provide access to their content by implementing . - - Controls such as and must implement if the value of any of the items is editable, regardless of the current edit mode of the control. The parent control must also implement if the child items are editable. - - ![Editable list item.](~/add/media/uia-valuepattern-editable-listitem.PNG "Editable list item.") -Example of an Editable List Item - - - -## Examples - The following example code demonstrates a custom control that allows its value to be set to a string of limited length. - + . However, multi-line edit controls do not implement ; instead they provide access to their content by implementing . + + Controls such as and must implement if the value of any of the items is editable, regardless of the current edit mode of the control. The parent control must also implement if the child items are editable. + + ![Editable list item.](~/add/media/uia-valuepattern-editable-listitem.PNG "Editable list item.") +Example of an Editable List Item + + + +## Examples + The following example code demonstrates a custom control that allows its value to be set to a string of limited length. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IValueProvider/IsReadOnly/ValueFragment.cs" id="Snippetsetvalue"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetsetvalue"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetsetvalue"::: + ]]> If locale-specific information is passed to a control in an incorrect format such as an incorrectly formatted date. @@ -180,23 +180,23 @@ Example of an Editable List Item Gets the value of the control. The value of the control as a string. - (in addition to ). However, multi-line edit controls do not implement . - - To retrieve the textual contents of multi-line edit controls, the controls must implement . However, does not support setting the value of a control. - - does not support the retrieval of formatting information or substring values. Implement in these scenarios. - - - -## Examples - The following example shows an implementation of this method for a control that allows its value to be retrieved. - + (in addition to ). However, multi-line edit controls do not implement . + + To retrieve the textual contents of multi-line edit controls, the controls must implement . However, does not support setting the value of a control. + + does not support the retrieval of formatting information or substring values. Implement in these scenarios. + + + +## Examples + The following example shows an implementation of this method for a control that allows its value to be retrieved. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/IValueProvider/IsReadOnly/ValueFragment.cs" id="Snippetvalue"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetvalue"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAIValueProvider_snip/visualbasic/valuefragment.vb" id="Snippetvalue"::: + ]]> diff --git a/xml/System.Windows.Automation.Provider/IVirtualizedItemProvider.xml b/xml/System.Windows.Automation.Provider/IVirtualizedItemProvider.xml index 6496f6cc273..e3ed448c135 100644 --- a/xml/System.Windows.Automation.Provider/IVirtualizedItemProvider.xml +++ b/xml/System.Windows.Automation.Provider/IVirtualizedItemProvider.xml @@ -35,11 +35,11 @@ Exposes a method to support the virtualized item control pattern. - method makes a virtual item fully accessible as a UI Automation element. A virtualized item is typically an item in a virtual list; that is, a list that does not manage its own data. When an application retrieves an automation element for a virtualized item by using the method, the provider may return a placeholder element that implements the interface. The implementation of the method returns a full UI Automation element reference. - + method makes a virtual item fully accessible as a UI Automation element. A virtualized item is typically an item in a virtual list; that is, a list that does not manage its own data. When an application retrieves an automation element for a virtualized item by using the method, the provider may return a placeholder element that implements the interface. The implementation of the method returns a full UI Automation element reference. + ]]> @@ -70,11 +70,11 @@ Makes the virtual item fully accessible as a UI Automation element. - diff --git a/xml/System.Windows.Automation.Provider/IWindowProvider.xml b/xml/System.Windows.Automation.Provider/IWindowProvider.xml index 887bf981c12..6dc80690097 100644 --- a/xml/System.Windows.Automation.Provider/IWindowProvider.xml +++ b/xml/System.Windows.Automation.Provider/IWindowProvider.xml @@ -36,11 +36,11 @@ Exposes methods and properties to support UI Automation client access to controls that provide fundamental window-based functionality within a traditional graphical user interface (GUI). - control pattern. - + control pattern. + ]]> @@ -78,15 +78,15 @@ Attempts to close the window. - must return immediately without blocking. - - raises the event. If possible, the event should be raised after the control has completed its associated action. - - When called on a split pane control, this method will close the pane and remove the associated split. This method might also close all other panes, depending on implementation. - + must return immediately without blocking. + + raises the event. If possible, the event should be raised after the control has completed its associated action. + + When called on a split pane control, this method will close the pane and remove the associated split. This method might also close all other panes, depending on implementation. + ]]> When the control is unable to perform the requested action. @@ -344,13 +344,13 @@ if the window has entered the idle state; if the timeout occurred. - . - - The implementation is dependent on the underlying application framework; therefore this method might return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle. - + . + + The implementation is dependent on the underlying application framework; therefore this method might return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle. + ]]> When the parameter passed in is not a valid number. diff --git a/xml/System.Windows.Automation.Text/TextPatternRange.xml b/xml/System.Windows.Automation.Text/TextPatternRange.xml index 9e6c43d3d07..14deeba45ed 100644 --- a/xml/System.Windows.Automation.Text/TextPatternRange.xml +++ b/xml/System.Windows.Automation.Text/TextPatternRange.xml @@ -29,7 +29,7 @@ ## Remarks A can represent an insertion point, a subset, or all of the text in a container. - A will become invalid if one of the following occurs: the text in the container changes because of some user activity, or the method of is used to programmatically change the value of the text in the container. + A will become invalid if one of the following occurs: the text in the container changes because of some user activity, or the method of is used to programmatically change the value of the text in the container. ]]> @@ -111,7 +111,7 @@ from the and move the two endpoints to correspond with the endpoints of the original text range. + Alternatively, create a new from the and move the two endpoints to correspond with the endpoints of the original text range. The new range can be manipulated independently from the original. @@ -267,13 +267,13 @@ ## Remarks If the range is already an exact quantity of the specified units then it remains unchanged. - In order for the method to execute successfully, a sequence of actions is performed behind the scenes. + In order for the method to execute successfully, a sequence of actions is performed behind the scenes. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, making the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. -3. The range is moved forward or backward in the by the requested number of `unit` boundaries. +3. The range is moved forward or backward in the by the requested number of `unit` boundaries. 4. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. @@ -283,9 +283,9 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() > [!NOTE] > These steps are necessary since it is common for a screen reader to read out a full word, sentence, or entire paragraph at the insertion point or any virtual cursor position. - respects both hidden and visible text. The UI Automation client can check the for text visibility. + respects both hidden and visible text. The UI Automation client can check the for text visibility. - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -357,7 +357,7 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() There is no differentiation between hidden and visible text. UI Automation clients can use to check text visibility. > [!NOTE] -> Use to search the entire document. +> Use to search the entire document. @@ -414,7 +414,7 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() There is no differentiation between hidden and visible text. UI Automation clients can use to check text visibility. > [!NOTE] -> Use to search the entire document. +> Use to search the entire document. @@ -645,11 +645,11 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() respects both hidden and visible text. The UI Automation client can check the for text visibility. + respects both hidden and visible text. The UI Automation client can check the for text visibility. If `maxLength` is greater than the length of the text span of the caller, the string returned will be the plain text of the text range. - will not be affected by the order of endpoints in the text flow; it will always return the text between the Start and End endpoints of the text range in the logical text flow order. + will not be affected by the order of endpoints in the text flow; it will always return the text between the Start and End endpoints of the text range in the logical text flow order. @@ -700,27 +700,27 @@ Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() method to execute successfully. + When it is necessary to traverse the content of a text range, a series of steps are involved behind the scenes in order for the method to execute successfully. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, which makes the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. -3. The range is moved forward or backward in the by the requested number of `unit` boundaries. +3. The range is moved forward or backward in the by the requested number of `unit` boundaries. 4. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. ![Range adjustments by Move & ExpandToEnclosingUnit](~/add/media/uia-textpattern-moveandexpand-examples.png "Range adjustments by Move & ExpandToEnclosingUnit") Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() - The textual content (or inner text) of a text container and an embedded object, such as a hyperlink or table cell, is exposed as a single, continuous text stream in both the control view and the content view of the UI Automation tree; object boundaries are ignored. If a UI Automation client is retrieving the text for the purpose of reciting, interpreting, or analyzing in some manner, the text range should be checked for special cases, such as a table with textual content or other embedded objects. This can be accomplished by calling to obtain an for each embedded object and then calling to obtain a text range for each element; this is done recursively until all textual content has been retrieved. + The textual content (or inner text) of a text container and an embedded object, such as a hyperlink or table cell, is exposed as a single, continuous text stream in both the control view and the content view of the UI Automation tree; object boundaries are ignored. If a UI Automation client is retrieving the text for the purpose of reciting, interpreting, or analyzing in some manner, the text range should be checked for special cases, such as a table with textual content or other embedded objects. This can be accomplished by calling to obtain an for each embedded object and then calling to obtain a text range for each element; this is done recursively until all textual content has been retrieved. ![Text ranges spanned by embedded objects.](~/add/media/uia-textpattern-embeddedobjecttextranges.png "Text ranges spanned by embedded objects.") Example of a text stream with embedded objects and their range spans - respects both hidden and visible text. The UI Automation client can check the for text visibility. + respects both hidden and visible text. The UI Automation client can check the for text visibility. - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -844,23 +844,23 @@ Example of a text stream with embedded objects and their range spans method to execute successfully. + When it is necessary to traverse the content of a text range, a series of steps are involved behind the scenes in order for the method to execute successfully. 1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the endpoint, which makes the endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans `unit` boundaries; for example, "{The U}RL [https://www.microsoft.com/](https://www.microsoft.com/) is embedded in text" where "{" and "}" are the text range endpoints. -2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. +2. The resulting range is moved backward in the to the beginning of the requested `unit` boundary. 3. The range is then expanded from a degenerate range state by moving the endpoint by one requested `unit` boundary. ![Range adjustments by Move & ExpandToEnclosingUnit](~/add/media/uia-textpattern-moveandexpand-examples.png "Range adjustments by Move & ExpandToEnclosingUnit") Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit() - The textual content (or inner text) of a text container and an embedded object, such as a hyperlink or table cell, is exposed as a single, continuous text stream in both the control view and the content view of the UI Automation tree; object boundaries are ignored. If a UI Automation client is retrieving the text for the purpose of reciting, interpreting, or analyzing in some manner, the text range should be checked for special cases, such as a table with textual content or other embedded objects. This can be accomplished by calling to obtain an for each embedded object and then calling to obtain a text range for each element; this is done recursively until all textual content has been retrieved. + The textual content (or inner text) of a text container and an embedded object, such as a hyperlink or table cell, is exposed as a single, continuous text stream in both the control view and the content view of the UI Automation tree; object boundaries are ignored. If a UI Automation client is retrieving the text for the purpose of reciting, interpreting, or analyzing in some manner, the text range should be checked for special cases, such as a table with textual content or other embedded objects. This can be accomplished by calling to obtain an for each embedded object and then calling to obtain a text range for each element; this is done recursively until all textual content has been retrieved. ![Text ranges spanned by embedded objects.](~/add/media/uia-textpattern-embeddedobjecttextranges.png "Text ranges spanned by embedded objects.") Example of a text stream with embedded objects and their range spans - defers to the next largest supported if the given is not supported by the control. + defers to the next largest supported if the given is not supported by the control. The order, from smallest unit to largest, is listed below. @@ -965,7 +965,7 @@ Example of a text stream with embedded objects and their range spans respects both hidden and visible text. The UI Automation client can check the for text visibility. If the text range is hidden, the text control will scroll only if the hidden text has an anchor in the viewport. + respects both hidden and visible text. The UI Automation client can check the for text visibility. If the text range is hidden, the text control will scroll only if the hidden text has an anchor in the viewport. diff --git a/xml/System.Windows.Automation/Automation.xml b/xml/System.Windows.Automation/Automation.xml index be13e0af086..714213a2456 100644 --- a/xml/System.Windows.Automation/Automation.xml +++ b/xml/System.Windows.Automation/Automation.xml @@ -65,7 +65,7 @@ , expose fields identifying events that are specific to the class. The method provides a mechanism that enables you to register handlers for these events. + Some classes, such as , expose fields identifying events that are specific to the class. The method provides a mechanism that enables you to register handlers for these events. `eventHandler` can be an instance of the method, or a reference to the method (`AddressOf` in Visual Basic). @@ -309,7 +309,7 @@ throws an exception. + If either of the arguments is a null reference (`Nothing` in Visual Basic), throws an exception. @@ -361,7 +361,7 @@ throws an exception. + If either of the arguments is a null reference (`Nothing` in Visual Basic), throws an exception. This method is equivalent to the equality operator for objects. @@ -489,7 +489,7 @@ The following example displays the name of each control pattern supported by an . > [!NOTE] -> Calling requires a great deal of processing, as it queries the for every possible pattern. +> Calling requires a great deal of processing, as it queries the for every possible pattern. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet114"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet114"::: diff --git a/xml/System.Windows.Automation/AutomationElement+AutomationElementInformation.xml b/xml/System.Windows.Automation/AutomationElement+AutomationElementInformation.xml index 511be6a1d65..a0b489108bb 100644 --- a/xml/System.Windows.Automation/AutomationElement+AutomationElementInformation.xml +++ b/xml/System.Windows.Automation/AutomationElement+AutomationElementInformation.xml @@ -27,9 +27,9 @@ and ; you do not need to retrieve the structure itself. + The properties can be accessed directly from and ; you do not need to retrieve the structure itself. - The properties in this structure can also be retrieved by using and , using the corresponding identifiers from . For example, The property is identified by the field. More information about the individual properties is available on the reference pages for those identifiers; see the link in the Remarks section of each reference topic. + The properties in this structure can also be retrieved by using and , using the corresponding identifiers from . For example, The property is identified by the field. More information about the individual properties is available on the reference pages for those identifiers; see the link in the Remarks section of each reference topic. @@ -154,7 +154,7 @@ ## Remarks When it is available the of an element is expected to always be the same in any instance of the application regardless of the local language. The value should be unique among sibling elements but not necessarily unique across the entire desktop. For example, multiple instances of an application, or multiple folder views in Microsoft Windows Explorer, may contain elements with the same , such as "SystemMenuBar". - While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. + While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. For more information, see . @@ -350,7 +350,7 @@ is also true for the container element. + If an element within a container has focus, is also true for the container element. For more information, see . @@ -503,7 +503,7 @@ property can change because of UI interactions. You should get an updated cache by calling if the value of the property might have changed since you issued the cache request. + The value of the property can change because of UI interactions. You should get an updated cache by calling if the value of the property might have changed since you issued the cache request. For more information, see . diff --git a/xml/System.Windows.Automation/AutomationElement.xml b/xml/System.Windows.Automation/AutomationElement.xml index 0761b47798c..f707547804a 100644 --- a/xml/System.Windows.Automation/AutomationElement.xml +++ b/xml/System.Windows.Automation/AutomationElement.xml @@ -65,7 +65,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Accelerator key combinations invoke an action. For example, CTRL+O is often used to invoke the **Open** file common dialog box. An that has the accelerator key property set always implements the class. @@ -120,7 +120,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the **File Open** common dialog box from a **File** menu. @@ -276,13 +276,13 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is an empty string. When it is available the of an element is expected to always be the same in any instance of the application regardless of the local language. The value should be unique among sibling elements but not necessarily unique across the entire desktop. For example, multiple instances of an application, or multiple folder views in Microsoft Windows Explorer, may contain elements with the same , such as "SystemMenuBar". - While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. + While support of an is always recommended for better testability, this property is not mandatory. Where it is supported, an is useful for creating test automation scripts that run regardless of UI language. Clients should make no assumptions regarding the s exposed by other applications. An is not necessarily guaranteed to be stable across different releases or builds of an application. Instances of user interface (UI) elements are uniquely identified on the desktop by their properties. @@ -376,9 +376,9 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. - Bounding rectangles are of type . The returned rectangle is in physical screen coordinates. The default value is . is returned if the item is not currently displaying a user interface (UI). + Bounding rectangles are of type . The returned rectangle is in physical screen coordinates. The default value is . is returned if the item is not currently displaying a user interface (UI). The returned rectangle can contain points that are not clickable. Instances where this could happen include when the UI item has an irregular shape or clickable region, or it is obscured by other UI elements. @@ -431,7 +431,7 @@ . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . + The accessors for UI Automation properties are represented as properties of the structure returned by . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . To get the current value of UI Automation properties on this element use the property. @@ -481,7 +481,7 @@ condition of the that was active when this object was obtained. + The view of the returned collection is determined by the condition of the that was active when this object was obtained. Children are cached only if the scope of the included , , or . @@ -490,7 +490,7 @@ ## Examples - In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. + In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet119"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: @@ -532,7 +532,7 @@ properties of a list box and its list items are cached. The list box element is available in the property of each list item element. + In the following example, the properties of a list box and its list items are cached. The list box element is available in the property of each list item element. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet119"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: @@ -575,7 +575,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The class name depends on the implementation of the UI Automation provider and therefore cannot be counted upon to be in a standard format. However, if you know the class name you can use it to verify that your application is working with the expected UI Automation element. @@ -688,7 +688,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The default value for the property is @@ -791,7 +791,7 @@ . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . + The accessors for UI Automation properties are represented as properties of the structure returned by . You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see . To get the cached value of UI Automation properties on this element, use the property. @@ -928,7 +928,7 @@ ## Examples - The following example shows how to use to locate all enabled buttons in a window. + The following example shows how to use to locate all enabled buttons in a window. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet116"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet116"::: @@ -1192,7 +1192,7 @@ returns the element in the logical tree that is closest to the root element. + returns the element in the logical tree that is closest to the root element. If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. @@ -1248,7 +1248,7 @@ retrieves the specified pattern from the cache. To retrieve the current object for the specified pattern, call . + retrieves the specified pattern from the cache. To retrieve the current object for the specified pattern, call . This method throws an exception if the requested pattern was not previously cached. @@ -1278,7 +1278,7 @@ retrieves the specified property from the cache of the . To retrieve the current property, call . + retrieves the specified property from the cache of the . To retrieve the current property, call . ]]> @@ -1329,7 +1329,7 @@ ## Remarks If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - retrieves the specified property from the 's cache. To retrieve the current object for the specified property call . + retrieves the specified property from the 's cache. To retrieve the current object for the specified property call . This method throws an exception if the requested property was not previously cached. @@ -1383,9 +1383,9 @@ retrieves the specified property from the cache for the . To retrieve the current property, call . + retrieves the specified property from the cache for the . To retrieve the current property, call . - Passing `false` in `ignoreDefaultValue` is equivalent to calling . + Passing `false` in `ignoreDefaultValue` is equivalent to calling . If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . @@ -1502,9 +1502,9 @@ gets the specified pattern based on its availability at the time of the call. + gets the specified pattern based on its availability at the time of the call. - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using . + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using . @@ -1515,7 +1515,7 @@ :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet103"::: > [!NOTE] -> For often-repeated tasks such as the one in the example, it would be more efficient to cache the pattern and use . +> For often-repeated tasks such as the one in the example, it would be more efficient to cache the pattern and use . ]]> @@ -1535,9 +1535,9 @@ method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). + The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . ]]> @@ -1586,11 +1586,11 @@ method is current at the time it is called. The value can subsequently change by other applications interacting with the UI. + The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the UI. If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - For some forms of UI, this method will incur cross-process performance overhead. Concentrate overhead by caching properties and then retrieving them by using . + For some forms of UI, this method will incur cross-process performance overhead. Concentrate overhead by caching properties and then retrieving them by using . @@ -1641,13 +1641,13 @@ . + Passing `false` in `ignoreDefaultValue` is equivalent to calling . If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if `ignoreDefaultValue` is `false`, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of , such as . - The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). + The value returned by the method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI). - For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . + For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using . @@ -1771,7 +1771,7 @@ for every possible pattern. Normally you would use to retrieve a specific control pattern from an . To ascertain whether a particular pattern is supported, check the appropriate property; for example, . + This method would typically be used for debugging. Calling it requires a great deal of processing, as it queries the for every possible pattern. Normally you would use to retrieve a specific control pattern from an . To ascertain whether a particular pattern is supported, check the appropriate property; for example, . @@ -1817,7 +1817,7 @@ to determine whether a property is currently supported and to get its current value. + The returned array identifies all the properties supported by this element; however, it can also contain duplicate entries or properties that contain `null` or empty values. For most purposes it is better to use to determine whether a property is currently supported and to get its current value. @@ -1866,7 +1866,7 @@ is unchanged. returns a new , that refers to the same user interface (UI) and has the same . + The original is unchanged. returns a new , that refers to the same user interface (UI) and has the same . @@ -1912,7 +1912,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is `false`. @@ -1986,7 +1986,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. This information is typically obtained from tooltips specified by providers. @@ -2041,7 +2041,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The content view of the UI Automation tree provides a view of the UI that only contains elements that represent data within the UI. @@ -2100,7 +2100,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Controls are elements that a user perceives as interactive or containing information in the UI. @@ -2229,7 +2229,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is `false`. @@ -2490,9 +2490,9 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. - The property provides information necessary to the proper functioning of the method. + The property provides information necessary to the proper functioning of the method. Return values of the property are of type . The default value for the property is `false`. @@ -2586,11 +2586,11 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The return value is of type , and the default value is `false`. - For more information about when this property is `true`, see . + For more information about when this property is `true`, see . @@ -2641,7 +2641,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The return value for this property is a . It returns `true` to indicate that the content is protected; otherwise `false`. @@ -2735,7 +2735,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The return value for this property is of type , and the default value is `false`. @@ -3394,7 +3394,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The return value is a control-defined . The default value is an empty string. @@ -3447,7 +3447,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is `null`. @@ -3538,7 +3538,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. A provider is required to expose this property when it represents a custom control that does not have a well-defined control type. @@ -3665,7 +3665,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is an empty string. @@ -3718,7 +3718,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is 0. @@ -3847,7 +3847,7 @@ objects that compare as equal might contain different cached information from different points in time. only tests that the objects refer to the same underlying UI element. + Two objects that compare as equal might contain different cached information from different points in time. only tests that the objects refer to the same underlying UI element. ]]> @@ -3926,7 +3926,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. The value of the property is of type . The default value is . @@ -4012,7 +4012,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in . - This property can also be retrieved from the or properties. + This property can also be retrieved from the or properties. Return values of the property are of type . The default value for the property is 0. @@ -4064,7 +4064,7 @@ and methods. + You can use the root element as a starting point for finding other elements, using the and methods. When searching from the root element, be sure to specify in the scope of the search, not . A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow. @@ -4449,7 +4449,7 @@ . + For some forms of user interface (UI), this method will incur cross-process performance overhead. Applications can concentrate overhead by caching patterns and then retrieving them by using . diff --git a/xml/System.Windows.Automation/AutomationElementCollection.xml b/xml/System.Windows.Automation/AutomationElementCollection.xml index 2210ede38de..eb2ccbdc6e0 100644 --- a/xml/System.Windows.Automation/AutomationElementCollection.xml +++ b/xml/System.Windows.Automation/AutomationElementCollection.xml @@ -34,7 +34,7 @@ is used as the return type for methods such as . It is not intended to be used for application-defined collections, for which you should use a more generic class such as . + is used as the return type for methods such as . It is not intended to be used for application-defined collections, for which you should use a more generic class such as . ]]> diff --git a/xml/System.Windows.Automation/AutomationElementIdentifiers.xml b/xml/System.Windows.Automation/AutomationElementIdentifiers.xml index 8b9f65fbe29..6b3bbf12a8c 100644 --- a/xml/System.Windows.Automation/AutomationElementIdentifiers.xml +++ b/xml/System.Windows.Automation/AutomationElementIdentifiers.xml @@ -24,13 +24,13 @@ Contains values used as identifiers by UI Automation providers. - . - - For more information about individual properties, see the entries for the equivalent fields. - + . + + For more information about individual properties, see the entries for the equivalent fields. + ]]> Return Properties from a UI Automation Provider @@ -63,11 +63,11 @@ Identifies the property. - . - + . + ]]> @@ -99,11 +99,11 @@ Identifies the property. - . - + . + ]]> @@ -161,11 +161,11 @@ Identifies an event raised during asynchronous content-loading. - . - + . + ]]> @@ -197,11 +197,11 @@ Identifies an event that is raised when the focus has changed. - . - + . + ]]> @@ -233,11 +233,11 @@ Identifies the property. - . - + . + ]]> @@ -269,11 +269,11 @@ Identifies a property-changed event. - . - + . + ]]> @@ -305,11 +305,11 @@ Identifies the property. - . - + . + ]]> @@ -341,11 +341,11 @@ Identifies the property. - . - + . + ]]> @@ -377,11 +377,11 @@ Identifies the . - . - + . + ]]> @@ -440,11 +440,11 @@ Identifies the property. - . - + . + ]]> @@ -476,11 +476,11 @@ Identifies the culture property. - . - + . + ]]> @@ -512,11 +512,11 @@ Identifies the property that contains the underlying framework's name for the element. - . - + . + ]]> @@ -548,11 +548,11 @@ Identifies the property. - . - + . + ]]> @@ -610,11 +610,11 @@ Identifies the property. - . - + . + ]]> @@ -646,11 +646,11 @@ Identifies the property that indicates whether the element contains content that is valuable to the end user. - . - + . + ]]> @@ -682,11 +682,11 @@ Identifies the property. - . - + . + ]]> @@ -744,11 +744,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -780,11 +780,11 @@ Identifies the property, which specifies whether the user interface (UI) item referenced by the is enabled. - . - + . + ]]> @@ -816,11 +816,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -852,11 +852,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -888,16 +888,16 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - - - -## Examples - - + . + + + +## Examples + + ]]> @@ -928,11 +928,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -991,11 +991,11 @@ Identifies the property. - . - + . + ]]> @@ -1027,11 +1027,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1063,13 +1063,13 @@ Identifies the property, which indicates whether the UI Automation element is visible. - . - - For more information about when this property is `true`, see . - + . + + For more information about when this property is `true`, see . + ]]> @@ -1101,11 +1101,11 @@ Identifies the property. - . - + . + ]]> @@ -1137,11 +1137,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1173,11 +1173,11 @@ Identifies the property. - . - + . + ]]> @@ -1209,11 +1209,11 @@ Identifies the property that indicates whether is available for this UI Automation element. - . - + . + ]]> @@ -1245,11 +1245,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1281,11 +1281,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1317,11 +1317,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1380,11 +1380,11 @@ Identifies the property that indicates whether the is available on this UI Automation element. - . - + . + ]]> @@ -1416,11 +1416,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1452,11 +1452,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1488,11 +1488,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1524,11 +1524,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1560,11 +1560,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1623,11 +1623,11 @@ Identifies the property that indicates whether is available on this UI Automation element. - . - + . + ]]> @@ -1659,11 +1659,11 @@ Identifies the property that specifies the status of the visual representation of a complex item. - . - + . + ]]> @@ -1695,11 +1695,11 @@ Identifies the property. - . - + . + ]]> @@ -1731,11 +1731,11 @@ Identifies the property. - . - + . + ]]> @@ -1767,11 +1767,11 @@ Identifies the event that is raised when the layout is invalidated. - . - + . + ]]> @@ -1802,11 +1802,11 @@ Identifies the event that is raised when a live region changes. - @@ -1836,11 +1836,11 @@ This identifier is for use by UI automation providers. Identifies the property. - @@ -1871,11 +1871,11 @@ This identifier is for use by UI automation providers. Identifies the property. - . - + . + ]]> @@ -1907,11 +1907,11 @@ This identifier is for use by UI automation providers. Identifies the event that is raised when a menu is closed. - . - + . + ]]> @@ -1943,11 +1943,11 @@ This identifier is for use by UI automation providers. Identifies the event that is raised when a menu is opened. - . - + . + ]]> @@ -1979,11 +1979,11 @@ This identifier is for use by UI automation providers. Identifies the property. - . - + . + ]]> @@ -2015,11 +2015,11 @@ This identifier is for use by UI automation providers. Identifies the property. - . - + . + ]]> @@ -2077,11 +2077,11 @@ This identifier is for use by UI automation providers. Indicates that a property is not supported. - . - + . + ]]> @@ -2113,11 +2113,11 @@ This identifier is for use by UI automation providers. Identifies the property. - . - + . + ]]> @@ -2148,7 +2148,7 @@ This identifier is for use by UI automation providers. Describes the ordinal location of an automation element within a set of elements that are considered to be siblings. - to describe the ordinal location in the set. This functionality is available starting with Windows 10. @@ -2182,11 +2182,11 @@ The `PositionInSetProperty` works in coordination with Identifies the property. - . - + . + ]]> @@ -2218,11 +2218,11 @@ The `PositionInSetProperty` works in coordination with Identifies the property that contains the runtime identifier of the element. - . - + . + ]]> @@ -2254,7 +2254,7 @@ The `PositionInSetProperty` works in coordination with Gets the count of automation elements in a group or set that are considered to be siblings. - property to describe the count of items in the set. This functionality is available starting with Windows 10. @@ -2289,11 +2289,11 @@ The `PositionInSetProperty` works in coordination with Identifies the event that is raised when the UI Automation tree structure is changed. - . - + . + ]]> @@ -2325,11 +2325,11 @@ The `PositionInSetProperty` works in coordination with Identifies the event that is raised when a ToolTip is closed. - . - + . + ]]> @@ -2361,11 +2361,11 @@ The `PositionInSetProperty` works in coordination with Identifies the event that is raised when a ToolTip is opened. - . - + . + ]]> diff --git a/xml/System.Windows.Automation/AutomationElementMode.xml b/xml/System.Windows.Automation/AutomationElementMode.xml index 331c2583d73..59dd55693c0 100644 --- a/xml/System.Windows.Automation/AutomationElementMode.xml +++ b/xml/System.Windows.Automation/AutomationElementMode.xml @@ -23,23 +23,23 @@ Contains values that specify the type of reference to use when returning UI Automation elements. These values are used in the property. - or , require a full reference; attempting to perform these on an element that has none results in an . - - Using None can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references. - - - -## Examples - The following example shows how to set the mode on a . - + or , require a full reference; attempting to perform these on an element that has none results in an . + + Using None can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references. + + + +## Examples + The following example shows how to set the mode on a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet183"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet183"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet183"::: + ]]> diff --git a/xml/System.Windows.Automation/AutomationEvent.xml b/xml/System.Windows.Automation/AutomationEvent.xml index 9118e443a35..c2cb4932715 100644 --- a/xml/System.Windows.Automation/AutomationEvent.xml +++ b/xml/System.Windows.Automation/AutomationEvent.xml @@ -24,21 +24,21 @@ Identifies a UI Automation event. - . They are also found in the event arguments passed to UI Automation clients. - - It is not possible to create custom events. - - - -## Examples - In the following example event handler, the in the event arguments is compared with the that identifies the Invoked event. - + . They are also found in the event arguments passed to UI Automation clients. + + It is not possible to create custom events. + + + +## Examples + In the following example event handler, the in the event arguments is compared with the that identifies the Invoked event. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet173"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet173"::: + ]]> @@ -77,11 +77,11 @@ Retrieves an that encapsulates the specified numerical identifier. An that encapsulates the specified numerical identifier. - object. This method can be used by UI Automation providers to create such an object when only the numerical identifier (the inherited from ) is known. - + object. This method can be used by UI Automation providers to create such an object when only the numerical identifier (the inherited from ) is known. + ]]> diff --git a/xml/System.Windows.Automation/AutomationEventArgs.xml b/xml/System.Windows.Automation/AutomationEventArgs.xml index 22d6c4e35cc..0db54788b01 100644 --- a/xml/System.Windows.Automation/AutomationEventArgs.xml +++ b/xml/System.Windows.Automation/AutomationEventArgs.xml @@ -63,14 +63,14 @@ The event identifier. Initializes a new instance of the class. - and raise the event. - + and raise the event. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AutomationEventArgs/.ctor/ListFragment.cs" id="Snippet122"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet122"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFragmentProvider_snip/VisualBasic/ListFragment.vb" id="Snippet122"::: + ]]> @@ -108,19 +108,19 @@ Gets the event identifier. The event identifier. - instance, can be used to identify the event that the delegate should process. - - - -## Examples - In the following example, the event handler checks the of the event and handles the event accordingly. - + instance, can be used to identify the event that the delegate should process. + + + +## Examples + In the following example, the event handler checks the of the event and handles the event accordingly. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet173"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet173"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet173"::: + ]]> diff --git a/xml/System.Windows.Automation/AutomationIdentifier.xml b/xml/System.Windows.Automation/AutomationIdentifier.xml index a3d5cba931a..bfb1be58c79 100644 --- a/xml/System.Windows.Automation/AutomationIdentifier.xml +++ b/xml/System.Windows.Automation/AutomationIdentifier.xml @@ -28,11 +28,11 @@ Base class for types that identify control types, events, patterns, properties, and text attributes in UI Automation. - class is effectively abstract, as it has no constructor and cannot be instantiated by applications. - + class is effectively abstract, as it has no constructor and cannot be instantiated by applications. + ]]> @@ -137,11 +137,11 @@ Returns the hash code for this UI Automation identifier. A 32-bit signed integer hash code. - method. - + method. + ]]> @@ -222,21 +222,21 @@ Gets the registered programmatic name. The programmatic name. - is intended for debugging and diagnostic purposes only. The string is not localized. - - This property should not be used in string comparisons. To determine if two properties are the same, compare the property identifiers directly. - - - -## Examples - The following example displays the programmatic name of each property supported by an . - + is intended for debugging and diagnostic purposes only. The string is not localized. + + This property should not be used in string comparisons. To determine if two properties are the same, compare the property identifiers directly. + + + +## Examples + The following example displays the programmatic name of each property supported by an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet115"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet115"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet115"::: + ]]> diff --git a/xml/System.Windows.Automation/AutomationPattern.xml b/xml/System.Windows.Automation/AutomationPattern.xml index d6790dc3537..c2bce89c70c 100644 --- a/xml/System.Windows.Automation/AutomationPattern.xml +++ b/xml/System.Windows.Automation/AutomationPattern.xml @@ -24,21 +24,21 @@ Identifies a control pattern. - field identifies the control pattern. - - - -## Examples - The following example displays the of patterns supported by an . - - The following example shows how to request a specific pattern. - + field identifies the control pattern. + + + +## Examples + The following example displays the of patterns supported by an . + + The following example shows how to request a specific pattern. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet104"::: + ]]> UI Automation Control Patterns diff --git a/xml/System.Windows.Automation/AutomationProperty.xml b/xml/System.Windows.Automation/AutomationProperty.xml index 3708e3e738b..9d75fcb6b6b 100644 --- a/xml/System.Windows.Automation/AutomationProperty.xml +++ b/xml/System.Windows.Automation/AutomationProperty.xml @@ -24,19 +24,19 @@ Identifies a property of an . - and control pattern classes. - - - -## Examples - The following example adds a property-changed event handler, and the handler checks the member of the event arguments to determine the property that has been changed. - + and control pattern classes. + + + +## Examples + The following example adds a property-changed event handler, and the handler checks the member of the event arguments to determine the property that has been changed. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/PropertySnips.cs" id="Snippet172"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet172"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/PropertySnips.vb" id="Snippet172"::: + ]]> UI Automation Properties Overview @@ -73,11 +73,11 @@ Retrieves an that encapsulates a specified numerical identifier. To be added. - object. This method can be used to create such an object when only the numerical identifier (the inherited from ) is known. - + object. This method can be used to create such an object when only the numerical identifier (the inherited from ) is known. + ]]> diff --git a/xml/System.Windows.Automation/CacheRequest.xml b/xml/System.Windows.Automation/CacheRequest.xml index 3731a996a00..b4f1140be1a 100644 --- a/xml/System.Windows.Automation/CacheRequest.xml +++ b/xml/System.Windows.Automation/CacheRequest.xml @@ -29,25 +29,25 @@ ## Remarks Retrieving properties and patterns through UI Automation requires cross-process calls that can slow down performance. By caching values of proprieties and patterns in a batch operation, you can enhance the performance of your application. - Create a new cache request by calling the class constructor. The request is populated by repeated calls to the method. + Create a new cache request by calling the class constructor. The request is populated by repeated calls to the method. Only a single can be active. There are two ways to activate a request: -- Call on the request. This pushes the request onto the stack, and the request is popped when the object is disposed. To ensure disposal even if an exception is raised, use the return value from within a `using` block (`Using` in Visual Basic). +- Call on the request. This pushes the request onto the stack, and the request is popped when the object is disposed. To ensure disposal even if an exception is raised, use the return value from within a `using` block (`Using` in Visual Basic). -- Put the request onto the internal stack by calling . Only the topmost request on the stack is active, and it must be the next one removed from the stack by . Popping the request deactivates it. +- Put the request onto the internal stack by calling . Only the topmost request on the stack is active, and it must be the next one removed from the stack by . Popping the request deactivates it. UI Automation elements obtained while the request is active will have cached values for the properties and patterns specified. ## Examples - The following example shows how to use to cache patterns and properties. + The following example shows how to use to cache patterns and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet107"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: - The following example shows how to use and to cache patterns and properties. + The following example shows how to use and to cache patterns and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet108"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: @@ -124,12 +124,12 @@ and as a means of activating the . The object is pushed onto the stack when is called, and then popped off when it is disposed. To ensure disposal, place the return value within a `using` block (`Using` in Visual Basic). + Using this method is usually preferable to using and as a means of activating the . The object is pushed onto the stack when is called, and then popped off when it is disposed. To ensure disposal, place the return value within a `using` block (`Using` in Visual Basic). ## Examples - The following example shows how to use to cache patterns and properties. + The following example shows how to use to cache patterns and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet107"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet107"::: @@ -302,14 +302,14 @@ ## Remarks is the default value, and specifies that returned elements contain a full reference to the underlying UI. specifies that the returned elements have no reference to the underlying UI, and contain only cached information. - Certain operations on elements, including , , and , require a full reference; attempting to perform these on an element that has none results in an . + Certain operations on elements, including , , and , require a full reference; attempting to perform these on an element that has none results in an . Using can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references. ## Examples - In the following example, is set to , with the result that only cached properties and patterns are available for the retrieved object. + In the following example, is set to , with the result that only cached properties and patterns are available for the retrieved object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet108"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: @@ -418,14 +418,14 @@ The returned contains the same req method. Attempting to remove a request that is not the current one results in an exception. + Only the currently active request can be removed using the method. Attempting to remove a request that is not the current one results in an exception. - Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. + Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. ## Examples - The following example shows how to deactivate a by using . + The following example shows how to deactivate a by using . :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet108"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: @@ -470,12 +470,12 @@ The returned contains the same req ## Remarks Multiple objects can be placed onto the state stack. Cache requests must be removed from the stack in the order they were pushed on; otherwise, an exception is raised. - Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. + Unless you are nesting cache requests, it is preferable to use to place the request on the stack. The reason is that you can use within a `using` block (`Using` in Visual Basic), ensuring that the request is popped off the stack even if an exception is raised. ## Examples - The following example shows how to activate a by using . + The following example shows how to activate a by using . :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet108"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: @@ -528,7 +528,7 @@ The returned contains the same req ## Examples - In the following example, is set to so that caching is done for all elements, regardless of whether they are part of the content view or the control view. + In the following example, is set to so that caching is done for all elements, regardless of whether they are part of the content view or the control view. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet108"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet108"::: @@ -576,12 +576,12 @@ The returned contains the same req or is called. See the example. + The scope of caching is in relation to the object or objects being fetched, not in relation to the object on which or is called. See the example. ## Examples - In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. + In the following example, a list box element is obtained from the parent window element while a is active and is . The specified properties of the child elements (that is, the list items) are stored in the cache and can be retrieved from the of the list box. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet119"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet119"::: diff --git a/xml/System.Windows.Automation/ClientSettings.xml b/xml/System.Windows.Automation/ClientSettings.xml index d4f423afb84..48ba658022c 100644 --- a/xml/System.Windows.Automation/ClientSettings.xml +++ b/xml/System.Windows.Automation/ClientSettings.xml @@ -58,16 +58,16 @@ Name of the assembly. Registers an assembly that contains client-side providers. - . - - - -## Examples - For example code, see [Register a Client-Side Provider Assembly](/dotnet/framework/ui-automation/register-a-client-side-provider-assembly). - + . + + + +## Examples + For example code, see [Register a Client-Side Provider Assembly](/dotnet/framework/ui-automation/register-a-client-side-provider-assembly). + ]]> The assembly could not be loaded. @@ -104,16 +104,16 @@ An array of provider descriptions. Registers client-side providers. - . - - - -## Examples - For example code, see [Implement UI Automation Providers in a Client Application](/dotnet/framework/ui-automation/implement-ui-automation-providers-in-a-client-application). - + . + + + +## Examples + For example code, see [Implement UI Automation Providers in a Client Application](/dotnet/framework/ui-automation/implement-ui-automation-providers-in-a-client-application). + ]]> The assembly could not be loaded. diff --git a/xml/System.Windows.Automation/ClientSideProviderDescription.xml b/xml/System.Windows.Automation/ClientSideProviderDescription.xml index bb1c84ec386..216559bd531 100644 --- a/xml/System.Windows.Automation/ClientSideProviderDescription.xml +++ b/xml/System.Windows.Automation/ClientSideProviderDescription.xml @@ -67,18 +67,18 @@ The class name of the windows that the provider is used for. Initializes a new instance of the class. - Register a Client-side Provider Assembly @@ -119,15 +119,15 @@ Flags that specify behavior when matching window class names. Initializes a new instance of the class. - Register a Client-side Provider Assembly @@ -168,11 +168,11 @@ Gets the class name of the windows that the provider is used for. The window class name. - is `null`, the provider is called for all windows for which no other provider is found. - + is `null`, the provider is called for all windows for which no other provider is found. + ]]> Register a Client-side Provider Assembly diff --git a/xml/System.Windows.Automation/ControlType.xml b/xml/System.Windows.Automation/ControlType.xml index 90a7a9c28ed..ca578c439ba 100644 --- a/xml/System.Windows.Automation/ControlType.xml +++ b/xml/System.Windows.Automation/ControlType.xml @@ -402,7 +402,7 @@ ## Examples - The following example calls on every kind of contained as a static field in the class. + The following example calls on every kind of contained as a static field in the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ControlType/GetNeverSupportedPatterns/GetPatternsForm.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAControlTypePatterns_snip/visualbasic/getpatternsform.vb" id="Snippet101"::: @@ -449,7 +449,7 @@ ## Examples - The following example calls on every kind of contained as a static field in the class. + The following example calls on every kind of contained as a static field in the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ControlType/GetNeverSupportedPatterns/GetPatternsForm.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAControlTypePatterns_snip/visualbasic/getpatternsform.vb" id="Snippet101"::: @@ -771,7 +771,7 @@ properties are output along with other information. + In the following example, all control types are found by reflection, and their properties are output along with other information. :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ControlType/GetNeverSupportedPatterns/GetPatternsForm.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAControlTypePatterns_snip/visualbasic/getpatternsform.vb" id="Snippet101"::: diff --git a/xml/System.Windows.Automation/DockPattern+DockPatternInformation.xml b/xml/System.Windows.Automation/DockPattern+DockPatternInformation.xml index 26e7880f3fb..82182a9d739 100644 --- a/xml/System.Windows.Automation/DockPattern+DockPatternInformation.xml +++ b/xml/System.Windows.Automation/DockPattern+DockPatternInformation.xml @@ -27,7 +27,7 @@ and , using the corresponding identifiers from . For example, The property is identified by the field. More information about the individual properties is available on the reference pages for those identifiers; see the link in the Remarks section of each reference topic. + The properties in this structure can also be retrieved by using and , using the corresponding identifiers from . For example, The property is identified by the field. More information about the individual properties is available on the reference pages for those identifiers; see the link in the Remarks section of each reference topic. ]]> diff --git a/xml/System.Windows.Automation/DockPattern.xml b/xml/System.Windows.Automation/DockPattern.xml index 6f85014c2f7..53d293f1a5c 100644 --- a/xml/System.Windows.Automation/DockPattern.xml +++ b/xml/System.Windows.Automation/DockPattern.xml @@ -24,17 +24,17 @@ Represents controls that expose their dock properties within a docking container. - does not support any properties of the docking container or any properties of controls that might be docked adjacent to the current control within the docking container. - + does not support any properties of the docking container or any properties of controls that might be docked adjacent to the current control within the docking container. + ]]> @@ -69,13 +69,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -108,13 +108,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -145,25 +145,25 @@ Identifies the property. - . - - This property can also be retrieved from the or properties. - - The default value is . - - - -## Examples - In the following example, a value is obtained representing the current dock position for a control that supports . - + . + + This property can also be retrieved from the or properties. + + The default value is . + + + +## Examples + In the following example, a value is obtained representing the current dock position for a control that supports . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/DockPattern+DockPatternInformation/DockPosition/UIADockPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet100"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet100"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/DockPattern+DockPatternInformation/DockPosition/UIADockPattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet102"::: + ]]> @@ -194,21 +194,21 @@ Identifies the control pattern. - . - - The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/DockPattern+DockPatternInformation/DockPosition/UIADockPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -243,21 +243,21 @@ The dock position relative to the boundaries of the docking container and other elements within the container. Docks the at the requested within a docking container. - representing a control that supports the DockPattern control pattern has its `dockPosition` modified. - + representing a control that supports the DockPattern control pattern has its `dockPosition` modified. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/DockPattern+DockPatternInformation/DockPosition/UIADockPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/DockPattern+DockPatternInformation/DockPosition/UIADockPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet103"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIADockPattern_snip/VisualBasic/UIADockPattern_snippets.vb" id="Snippet103"::: + ]]> When a control is not able to execute the requested dock style. diff --git a/xml/System.Windows.Automation/ExpandCollapsePattern.xml b/xml/System.Windows.Automation/ExpandCollapsePattern.xml index 42b25047476..b9f031b1b3a 100644 --- a/xml/System.Windows.Automation/ExpandCollapsePattern.xml +++ b/xml/System.Windows.Automation/ExpandCollapsePattern.xml @@ -70,7 +70,7 @@ . Use to get the current value of a property. + Cached property values must have been previously requested using a . Use to get the current value of a property. For information on the properties available and their use, see . @@ -112,7 +112,7 @@ ## Remarks This is a blocking method that returns after the UI Automation element has been collapsed. - There are cases when a UI Automation element that is marked as a leaf node might not know whether it has children until either the or the method is called. This behavior is possible with a tree view control that does delayed loading of its child items. For example, Microsoft Windows Explorer might display the expand icon for a node even though there are currently no child items; when the icon is clicked, the control polls for child items, finds none, and removes the expand icon. In these cases clients should listen for a property-changed event on the property by registering an event handler with the method. + There are cases when a UI Automation element that is marked as a leaf node might not know whether it has children until either the or the method is called. This behavior is possible with a tree view control that does delayed loading of its child items. For example, Microsoft Windows Explorer might display the expand icon for a node even though there are currently no child items; when the icon is clicked, the control polls for child items, finds none, and removes the expand icon. In these cases clients should listen for a property-changed event on the property by registering an event handler with the method. @@ -161,7 +161,7 @@ with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + This pattern must be from an with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . For information on the properties available and their use, see . @@ -202,7 +202,7 @@ ## Remarks This is a blocking method that returns after the has been expanded. - There are cases when a that is marked as a leaf node might not know whether it has children until either the or the method is called. This behavior is possible with a tree view control that does delayed loading of its child items. For example, Microsoft Windows Explorer might display the expand icon for a node even though there are currently no child items; when the icon is clicked, the control polls for child items, finds none, and removes the expand icon. In these cases clients should listen for a property-changed event on the property by registering an event handler with the method. + There are cases when a that is marked as a leaf node might not know whether it has children until either the or the method is called. This behavior is possible with a tree view control that does delayed loading of its child items. For example, Microsoft Windows Explorer might display the expand icon for a node even though there are currently no child items; when the icon is clicked, the control polls for child items, finds none, and removes the expand icon. In these cases clients should listen for a property-changed event on the property by registering an event handler with the method. @@ -300,7 +300,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified . + The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified . diff --git a/xml/System.Windows.Automation/GridItemPattern.xml b/xml/System.Windows.Automation/GridItemPattern.xml index c2e450894ec..ea39740c6af 100644 --- a/xml/System.Windows.Automation/GridItemPattern.xml +++ b/xml/System.Windows.Automation/GridItemPattern.xml @@ -24,11 +24,11 @@ Represents child controls of containers that support . - can typically be traversed (that is, a UI Automation client can move to adjacent controls) by using the keyboard. - + can typically be traversed (that is, a UI Automation client can move to adjacent controls) by using the keyboard. + ]]> @@ -64,13 +64,13 @@ Gets the cached property values for this . The cached property values. - . To get the current value of a property, get the property by using . - - For information on the properties available and their use, see . - + . To get the current value of a property, get the property by using . + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -102,19 +102,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -145,19 +145,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -188,19 +188,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -232,13 +232,13 @@ Gets the current property values for this . The current property values. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -269,21 +269,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -314,19 +314,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -357,19 +357,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridItemPattern+GridItemPatternInformation/Column/UIAGridItemPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridItemPattern_snip/VisualBasic/UIAGridItemPattern_snippets.vb" id="Snippet104"::: + ]]> diff --git a/xml/System.Windows.Automation/GridPattern+GridPatternInformation.xml b/xml/System.Windows.Automation/GridPattern+GridPatternInformation.xml index cd26d550b78..37f5a7034f3 100644 --- a/xml/System.Windows.Automation/GridPattern+GridPatternInformation.xml +++ b/xml/System.Windows.Automation/GridPattern+GridPatternInformation.xml @@ -57,25 +57,25 @@ Gets the number of columns in a grid. The total number of columns in a grid. - and properties. If the hidden rows and columns have not yet been loaded they are not counted. - - The default value is 0. - - - -## Examples - In the following example, an event listener is set up for a grid structure change such as a row or column grid item being added or removed from the grid. - + and properties. If the hidden rows and columns have not yet been loaded they are not counted. + + The default value is 0. + + + +## Examples + In the following example, an event listener is set up for a grid structure change such as a row or column grid item being added or removed from the grid. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet102"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet102"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet103"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet103"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -107,25 +107,25 @@ Gets the total number of rows in a grid. The total number of rows in a grid. - and properties. If the hidden rows and columns have not yet been loaded they will not be counted. - - The default value is 0. - - - -## Examples - In the following example, an event listener is set up for a grid structure change such as a row or column grid item being added or removed from the grid. - + and properties. If the hidden rows and columns have not yet been loaded they will not be counted. + + The default value is 0. + + + +## Examples + In the following example, an event listener is set up for a grid structure change such as a row or column grid item being added or removed from the grid. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet102"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet102"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet103"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet103"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/GridPattern+GridPatternInformation/ColumnCount/UIAGridPattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAGridPattern_snip/VisualBasic/UIAGridPattern_snippets.vb" id="Snippet101"::: + ]]> diff --git a/xml/System.Windows.Automation/GridPattern.xml b/xml/System.Windows.Automation/GridPattern.xml index 0e3667ad98f..f4f0fce9263 100644 --- a/xml/System.Windows.Automation/GridPattern.xml +++ b/xml/System.Windows.Automation/GridPattern.xml @@ -69,7 +69,7 @@ . Use to get the current value of a property. + Cached property values must have been previously requested using a . Use to get the current value of a property. For information on the properties available and their use, see . @@ -151,7 +151,7 @@ with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + This pattern must be from an with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . For information on the properties available and their use, see . @@ -252,7 +252,7 @@ The requested row coordinate is larger than the . - . - + . + ]]> UI Automation Control Patterns Overview @@ -63,15 +63,15 @@ Identifies the property. - . - - Hidden rows and columns, depending on the provider implementation, may be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they are not be counted. - - The default value is 0. - + . + + Hidden rows and columns, depending on the provider implementation, may be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they are not be counted. + + The default value is 0. + ]]> Implementing the UI Automation Grid Control Pattern @@ -103,11 +103,11 @@ Identifies the pattern. - . - + . + ]]> Implementing the UI Automation Grid Control Pattern @@ -139,15 +139,15 @@ Identifies the property. - . - - Hidden rows and columns, depending on the provider implementation, may be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they will not be counted. - - The default value is 0. - + . + + Hidden rows and columns, depending on the provider implementation, may be loaded in the UI Automation tree and will therefore be reflected in the and properties. If the hidden rows and columns have not yet been loaded they will not be counted. + + The default value is 0. + ]]> Implementing the UI Automation Grid Control Pattern diff --git a/xml/System.Windows.Automation/InvokePattern.xml b/xml/System.Windows.Automation/InvokePattern.xml index dcb2e5dcadc..f13975fa3cb 100644 --- a/xml/System.Windows.Automation/InvokePattern.xml +++ b/xml/System.Windows.Automation/InvokePattern.xml @@ -24,13 +24,13 @@ Represents controls that initiate or perform a single, unambiguous action and do not maintain state when activated. - if the same behavior is not exposed through another control pattern. For example, if the method on a control performs the same action as the or method, the control will not support . - - UI Automation elements that represent controls such as check boxes and radio buttons, which maintain a state, instead support or . - + if the same behavior is not exposed through another control pattern. For example, if the method on a control performs the same action as the or method, the control will not support . + + UI Automation elements that represent controls such as check boxes and radio buttons, which maintain a state, instead support or . + ]]> @@ -67,19 +67,19 @@ Sends a request to activate a control and initiate its single, unambiguous action. - should return immediately without blocking. However, this behavior is entirely dependent on the Microsoft UI Automation provider implementation. In scenarios where calling causes a blocking issue (such as a modal dialog) a separate helper thread may be required to call the method. - - - -## Examples - In the following example an control pattern is obtained from a control and the method is called. - + should return immediately without blocking. However, this behavior is entirely dependent on the Microsoft UI Automation provider implementation. In scenarios where calling causes a blocking issue (such as a modal dialog) a separate helper thread may be required to call the method. + + + +## Examples + In the following example an control pattern is obtained from a control and the method is called. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/InvokePattern/Invoke/UIAInvokePattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAInvokePattern_snip/VisualBasic/UIAInvokePattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAInvokePattern_snip/VisualBasic/UIAInvokePattern_snippets.vb" id="Snippet101"::: + ]]> The element does not support the control pattern or is hidden or blocked. @@ -114,21 +114,21 @@ Identifies the event raised when a control is invoked or activated. - . - - The identifier is passed as a parameter to . - - - -## Examples - In the following example, the event handler identifies the event as an Invoked event by comparing the in the event arguments with the identifier field. - + . + + The identifier is passed as a parameter to . + + + +## Examples + In the following example, the event handler identifies the event as an Invoked event by comparing the in the event arguments with the identifier field. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet101"::: + ]]> Invoke a Control Using UI Automation @@ -161,21 +161,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example an control pattern is obtained from a control and the method is called. - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example an control pattern is obtained from a control and the method is called. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/InvokePattern/Invoke/UIAInvokePattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAInvokePattern_snip/VisualBasic/UIAInvokePattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAInvokePattern_snip/VisualBasic/UIAInvokePattern_snippets.vb" id="Snippet101"::: + ]]> Invoke a Control Using UI Automation diff --git a/xml/System.Windows.Automation/ItemContainerPattern.xml b/xml/System.Windows.Automation/ItemContainerPattern.xml index 32c6f5a2ea7..9a327093955 100644 --- a/xml/System.Windows.Automation/ItemContainerPattern.xml +++ b/xml/System.Windows.Automation/ItemContainerPattern.xml @@ -59,11 +59,11 @@ Retrieves an element by the specified property value. The first item that matches the search criterion; otherwise, if no items match. - @@ -93,13 +93,13 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . - + . + + The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . + ]]> diff --git a/xml/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation.xml b/xml/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation.xml index d0b95ef6e49..452de30887f 100644 --- a/xml/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation.xml +++ b/xml/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation.xml @@ -57,21 +57,21 @@ Retrieves the current control-specific view. The integer value for the current view of the . The default value is 0. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet1035"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet1035"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet1035"::: + ]]> @@ -104,23 +104,23 @@ Retrieves a collection of control-specific view identifiers. A collection of integer values that identify the views available for an . The default is an empty integer array. - . - - - -## Examples - In the following example, a collection of integer identifiers is obtained, representing the views available for a control that supports . - + . + + + +## Examples + In the following example, a collection of integer identifiers is obtained, representing the views available for a control that supports . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet1025"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet1025"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet1025"::: + ]]> diff --git a/xml/System.Windows.Automation/MultipleViewPattern.xml b/xml/System.Windows.Automation/MultipleViewPattern.xml index 1a606421212..092dab762c0 100644 --- a/xml/System.Windows.Automation/MultipleViewPattern.xml +++ b/xml/System.Windows.Automation/MultipleViewPattern.xml @@ -24,11 +24,11 @@ Represents controls that provide, and are able to switch between, multiple representations of the same set of information or child controls. - @@ -63,13 +63,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -102,13 +102,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -139,21 +139,21 @@ Identifies the property. - . - - - -## Examples - In the following example, an integer is obtained that represents the current view for a control that supports . - + . + + + +## Examples + In the following example, an integer is obtained that represents the current view for a control that supports . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet100"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet100"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet103"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet103"::: + ]]> @@ -189,23 +189,23 @@ Retrieves the name of a control-specific view. A localized string representing the control-specific view name. - . - - The control-specific collection of view identifiers is identical across instances. - - View names are suitable for use in Text to Speech, Braille, and other accessible applications. - - - -## Examples - In the following example, the control-specific name of the current view is retrieved from a control that supports . - + . + + The control-specific collection of view identifiers is identical across instances. + + View names are suitable for use in Text to Speech, Braille, and other accessible applications. + + + +## Examples + In the following example, the control-specific name of the current view is retrieved from a control that supports . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet105"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet105"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet105"::: + ]]> @@ -238,21 +238,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -287,21 +287,21 @@ A control-specific view identifier. Sets the current control-specific view. - . - - The control-specific collection of view identifiers is identical across instances. - - - -## Examples - In the following example, the collection of views available for a control that supports the control pattern is retrieved. A member of the view identifiers collection is subsequently used to modify the current view of the control. - + . + + The control-specific collection of view identifiers is identical across instances. + + + +## Examples + In the following example, the collection of views available for a control that supports the control pattern is retrieved. A member of the view identifiers collection is subsequently used to modify the current view of the control. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -334,23 +334,23 @@ Identifies the property that gets the control-specific collection of views. - . - - This property is not present in and must be retrieved by using or . - - - -## Examples - In the following example, a collection of integer identifiers is obtained that represents the current views available for a control that supports . - + . + + This property is not present in and must be retrieved by using or . + + + +## Examples + In the following example, a collection of integer identifiers is obtained that represents the current views available for a control that supports . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet100"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet100"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/MultipleViewPattern+MultipleViewPatternInformation/CurrentView/UIAMultipleViewPattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAMultipleViewPattern_snip/VisualBasic/UIAMultipleViewPattern_snippets.vb" id="Snippet102"::: + ]]> diff --git a/xml/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation.xml b/xml/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation.xml index 5cbe7ad9ae5..41ed734f016 100644 --- a/xml/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation.xml +++ b/xml/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation.xml @@ -58,23 +58,23 @@ if the value is read-only; if it can be modified. The default is . - set to `true` and its set to `false` prior to the creation of a object. - - - -## Examples - In the following example, an that supports the control pattern has its value incremented or decremented by the control-specific value. - + set to `true` and its set to `false` prior to the creation of a object. + + + +## Examples + In the following example, an that supports the control pattern has its value incremented or decremented by the control-specific value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103largechange"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103largechange"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103largechange"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -106,18 +106,18 @@ Gets the control-specific large-change value which is added to or subtracted from the property. The large-change value or if the element does not support . The default value is 0.0. - that supports the control pattern has its value incremented or decremented by the control-specific value. - + that supports the control pattern has its value incremented or decremented by the control-specific value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103largechange"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103largechange"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103largechange"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -150,18 +150,18 @@ Gets the maximum range value supported by the UI Automation element. The maximum value supported by the UI Automation element or if the element does not support . The default value is 0.0. - that supports the control pattern has its value set to the control-specific maximum value. - + that supports the control pattern has its value set to the control-specific maximum value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet104maximum"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104maximum"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104maximum"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet104"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -194,18 +194,18 @@ Gets the minimum range value supported by the UI Automation element. The minimum value supported by the UI Automation element or if the element does not support . The default value is 0.0. - that supports the control pattern has its value set to the control-specific minimum value. - + that supports the control pattern has its value set to the control-specific minimum value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet104minimum"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104minimum"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104minimum"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet104"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet104"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -238,18 +238,18 @@ Gets the small-change value, unique to the UI Automation element, which is added to or subtracted from the elements property. The small-change value unique to the UI Automation element or if the element does not support . The default value is 0.0. - that supports the control pattern has its value incremented or decremented by the control-specific value. - + that supports the control pattern has its value incremented or decremented by the control-specific value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103smallchange"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103smallchange"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103smallchange"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet103"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -282,14 +282,14 @@ Gets the current value of the UI Automation element. The current value of the UI Automation element or if the element does not support . The default value is 0.0. - object obtained from a target control is passed into a function that retrieves the current property values. - + object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/RangeValuePattern+RangeValuePatternInformation/IsReadOnly/UIARangeValuePattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb" id="Snippet102"::: + ]]> diff --git a/xml/System.Windows.Automation/RangeValuePattern.xml b/xml/System.Windows.Automation/RangeValuePattern.xml index 0fcf832af09..35635fe9fce 100644 --- a/xml/System.Windows.Automation/RangeValuePattern.xml +++ b/xml/System.Windows.Automation/RangeValuePattern.xml @@ -67,7 +67,7 @@ . To get the value of a property at the current point in time, get the property by using . + Cached property values must have been previously requested using a . To get the value of a property at the current point in time, get the property by using . For information on the properties available and their use, see . @@ -109,7 +109,7 @@ with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + This pattern must be from an with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . For information on the properties available and their use, see . @@ -326,7 +326,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . diff --git a/xml/System.Windows.Automation/RangeValuePatternIdentifiers.xml b/xml/System.Windows.Automation/RangeValuePatternIdentifiers.xml index d6407420bbf..3e12ac1bd8c 100644 --- a/xml/System.Windows.Automation/RangeValuePatternIdentifiers.xml +++ b/xml/System.Windows.Automation/RangeValuePatternIdentifiers.xml @@ -24,11 +24,11 @@ Contains values used as identifiers for . - . - + . + ]]> @@ -64,11 +64,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -100,11 +100,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -136,11 +136,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -172,11 +172,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -208,13 +208,13 @@ Identifies this pattern as a . - . - - The pattern identifier (ID) is passed to methods such as to specify the pattern to return. - + . + + The pattern identifier (ID) is passed to methods such as to specify the pattern to return. + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -246,11 +246,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern @@ -282,11 +282,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation RangeValue Control Pattern diff --git a/xml/System.Windows.Automation/ScrollItemPattern.xml b/xml/System.Windows.Automation/ScrollItemPattern.xml index 586b505d342..4d108e9dbf9 100644 --- a/xml/System.Windows.Automation/ScrollItemPattern.xml +++ b/xml/System.Windows.Automation/ScrollItemPattern.xml @@ -24,11 +24,11 @@ Represents child controls of containers that support the control pattern. - @@ -62,21 +62,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollItemPattern/Pattern/UIAScrollItemPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -108,21 +108,21 @@ Scrolls the content area of a container object in order to display the within the visible region (viewport) of the container. - within the visible region (viewport) of the container. - - - -## Examples - In the following example, a , or event handler has been declared that attempts to scroll a object into the viewable region of its container control. - + within the visible region (viewport) of the container. + + + +## Examples + In the following example, a , or event handler has been declared that attempts to scroll a object into the viewable region of its container control. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollItemPattern/Pattern/UIAScrollItemPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet100"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet100"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollItemPattern/Pattern/UIAScrollItemPattern_snippets.cs" id="Snippet101"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet101"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollItemPattern_snip/VisualBasic/UIAScrollItemPattern_snippets.vb" id="Snippet101"::: + ]]> The item could not be scrolled into view. diff --git a/xml/System.Windows.Automation/ScrollPattern+ScrollPatternInformation.xml b/xml/System.Windows.Automation/ScrollPattern+ScrollPatternInformation.xml index 3710a7c3e80..b3244615dd3 100644 --- a/xml/System.Windows.Automation/ScrollPattern+ScrollPatternInformation.xml +++ b/xml/System.Windows.Automation/ScrollPattern+ScrollPatternInformation.xml @@ -57,21 +57,21 @@ if the UI Automation element can scroll horizontally; otherwise . The default value is . - is `false`. However, resizing the UI Automation element or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. - - - -## Examples - In the following example, a control pattern is obtained from a UI Automation element and is then used to horizontally scroll the element the requested amount. - + is `false`. However, resizing the UI Automation element or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. + + + +## Examples + In the following example, a control pattern is obtained from a UI Automation element and is then used to horizontally scroll the element the requested amount. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet107"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet107"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet107"::: + ]]> @@ -103,14 +103,14 @@ Gets the current horizontal scroll position. The horizontal scroll position as a percentage of the total content area within the UI Automation element. The default value is 0.0. - object obtained from a target control is passed into a function that retrieves the current horizontal and vertical scroll percentages of the viewable region within the content area. - + object obtained from a target control is passed into a function that retrieves the current horizontal and vertical scroll percentages of the viewable region within the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet1045"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1045"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1045"::: + ]]> @@ -142,14 +142,14 @@ Gets the current horizontal view size. The horizontal size of the viewable region as a percentage of the total content area within the UI Automation element. The default value is 100.0. - object obtained from a target control is passed into a function that retrieves the current vertical and horizontal sizes of the viewable region as percentages of the total content area. - + object obtained from a target control is passed into a function that retrieves the current vertical and horizontal sizes of the viewable region as percentages of the total content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet1055"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1055"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1055"::: + ]]> @@ -182,21 +182,21 @@ if the UI Automation element can scroll horizontally; otherwise . The default value is . - is `false`. However, resizing the UI Automation element or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. - - - -## Examples - In the following example, a control pattern is obtained from a UI Automation element and is then used to vertically scroll the element the requested amount. - + is `false`. However, resizing the UI Automation element or adding child items can increase the bounds of the content area beyond the viewable area, indicating that is `true`. + + + +## Examples + In the following example, a control pattern is obtained from a UI Automation element and is then used to vertically scroll the element the requested amount. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet108"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet108"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet108"::: + ]]> @@ -228,14 +228,14 @@ Gets the current vertical scroll position. The vertical scroll position as a percentage of the total content area within the UI Automation element. The default value is 0.0. - object obtained from a target control is passed into a function that retrieves the current horizontal and vertical scroll percentages of the viewable region within the content area. - + object obtained from a target control is passed into a function that retrieves the current horizontal and vertical scroll percentages of the viewable region within the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet1045"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1045"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1045"::: + ]]> @@ -267,14 +267,14 @@ Gets the current vertical view size. The vertical size of the viewable region as a percentage of the total content area within the UI Automation element. The default value is 100.0. - object obtained from a target control is passed into a function that retrieves the current vertical and horizontal sizes of the viewable region as percentages of the total content area. - + object obtained from a target control is passed into a function that retrieves the current vertical and horizontal sizes of the viewable region as percentages of the total content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet1055"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1055"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet1055"::: + ]]> diff --git a/xml/System.Windows.Automation/ScrollPattern.xml b/xml/System.Windows.Automation/ScrollPattern.xml index fc5c2a348b8..5eb5f8b2620 100644 --- a/xml/System.Windows.Automation/ScrollPattern.xml +++ b/xml/System.Windows.Automation/ScrollPattern.xml @@ -24,11 +24,11 @@ Represents controls that act as scrollable containers for a collection of child elements. The children of this element support . - @@ -63,13 +63,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -102,13 +102,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -139,19 +139,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -183,19 +183,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns the current horizontal and vertical scroll percentages of the viewable region within the content area. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns the current horizontal and vertical scroll percentages of the viewable region within the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -227,19 +227,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns the current vertical and horizontal sizes of the viewable region as percentages of the total content area. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns the current vertical and horizontal sizes of the viewable region as percentages of the total content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet105"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet105"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet105"::: + ]]> @@ -272,21 +272,21 @@ Specifies that scrolling should not be performed. - . - - The value -1 can be substituted for the field. - - - -## Examples - In the following example, a control pattern is obtained from an and is then used to scroll the viewable region to the top of the content area. - + . + + The value -1 can be substituted for the field. + + + +## Examples + In the following example, a control pattern is obtained from an and is then used to scroll the viewable region to the top of the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet103"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet103"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet103"::: + ]]> @@ -317,21 +317,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -368,16 +368,16 @@ The vertical increment specific to the control. should be passed in if the control cannot be scrolled in this direction. Scrolls the visible region of the content area horizontally and vertically. - control pattern is obtained from an and is then used to scroll the element a requested amount either horizontally or vertically. - + control pattern is obtained from an and is then used to scroll the element a requested amount either horizontally or vertically. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet106"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet106"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet106"::: + ]]> A control supports values exclusively for horizontal or vertical scrolling but a value is passed in. @@ -416,16 +416,16 @@ The horizontal increment specific to the control. Scrolls the currently visible region of the content area, horizontally, the specified . - control pattern is obtained from an and is then used to horizontally scroll the element a requested amount. - + control pattern is obtained from an and is then used to horizontally scroll the element a requested amount. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet107"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet107"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet107"::: + ]]> If a control supports values exclusively for horizontal or vertical scrolling but a value is passed in. @@ -464,16 +464,16 @@ The vertical increment specific to the control. Scrolls the currently visible region of the content area, vertically, the specified . - control pattern is obtained from an and is then used to vertically scroll the element a requested amount. - + control pattern is obtained from an and is then used to vertically scroll the element a requested amount. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet108"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet108"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet108"::: + ]]> If a control supports values exclusively for horizontal or vertical scrolling but a value is passed in. @@ -514,23 +514,23 @@ The percentage of the total vertical content area. should be passed in if the control cannot be scrolled in this direction. Sets the horizontal and/or vertical scroll position as a percentage of the total content area within the . - indicates that there is no scrolling in the specified direction. - - - -## Examples - In the following example, a control pattern is obtained from an and is then used to scroll the viewable region to the top left 'home' position of the content area. - + indicates that there is no scrolling in the specified direction. + + + +## Examples + In the following example, a control pattern is obtained from an and is then used to scroll the viewable region to the top left 'home' position of the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet102"::: + ]]> A value that cannot be converted to a double is passed in. @@ -564,19 +564,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of s that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of s that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -608,19 +608,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns the current scroll percentages of the viewable region within the content area. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns the current scroll percentages of the viewable region within the content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -652,19 +652,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns the current vertical and horizontal sizes of the viewable region as percentages of the total content area. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns the current vertical and horizontal sizes of the viewable region as percentages of the total content area. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ScrollPattern+ScrollPatternInformation/HorizontallyScrollable/UIAScrollPattern_snippets.cs" id="Snippet105"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet105"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAScrollPattern_snip/VisualBasic/UIAScrollPattern_snippets.vb" id="Snippet105"::: + ]]> diff --git a/xml/System.Windows.Automation/SelectionItemPattern.xml b/xml/System.Windows.Automation/SelectionItemPattern.xml index db4853cdc04..8f54f3d3242 100644 --- a/xml/System.Windows.Automation/SelectionItemPattern.xml +++ b/xml/System.Windows.Automation/SelectionItemPattern.xml @@ -24,11 +24,11 @@ Represents selectable child items of container controls that support . - @@ -63,16 +63,16 @@ Adds the current element to the collection of selected items. - An attempt is made to add a selection to a single-selection container where = and another element is already selected. @@ -105,13 +105,13 @@ Gets the cached property values for this . The cached property values. - . To get the current value of a property, get the property by using . - - For information on the properties available and their use, see . - + . To get the current value of a property, get the property by using . + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -144,13 +144,13 @@ Gets the current property values for this . The current property values. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -181,21 +181,21 @@ Identifies the event raised when an item is added to a collection of selected items. - call is a single selected item, then an will be raised instead. - - This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - - - -## Examples - In the following example, event listeners are declared for the events. - + call is a single selected item, then an will be raised instead. + + This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . + + + +## Examples + In the following example, event listeners are declared for the events. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -226,21 +226,21 @@ Identifies the event raised when an item is removed from a collection of selected items. - call is a single selected item, then an will be raised instead. - - This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - - - -## Examples - In the following example, event listeners are declared for the events. - + call is a single selected item, then an will be raised instead. + + This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . + + + +## Examples + In the following example, event listeners are declared for the events. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -271,19 +271,19 @@ Identifies the event that is raised when a call to any of , , or results in a single item being selected. - . - - - -## Examples - In the following example, event listeners are declared for the events. - + . + + + +## Examples + In the following example, event listeners are declared for the events. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -314,19 +314,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -357,21 +357,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet102"::: + ]]> @@ -403,16 +403,16 @@ Removes the current element from the collection of selected items. - An attempt is made to remove a selection from a selection container where one item is selected and = . @@ -445,14 +445,14 @@ Deselects any selected items and then selects the current element. - @@ -483,19 +483,19 @@ Identifies the property. - . - - - -## Examples - The following example shows how to retrieve the representing the selection container of a selection item. - + . + + + +## Examples + The following example shows how to retrieve the representing the selection container of a selection item. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionItemPattern+SelectionItemPatternInformation/IsSelected/UIASelectionItemPattern_snippets.cs" id="Snippet1035"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet1035"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionItemPattern_snip/VisualBasic/UIASelectionItemPattern_snippets.vb" id="Snippet1035"::: + ]]> diff --git a/xml/System.Windows.Automation/SelectionItemPatternIdentifiers.xml b/xml/System.Windows.Automation/SelectionItemPatternIdentifiers.xml index d9810c6f57e..b0a530ed16e 100644 --- a/xml/System.Windows.Automation/SelectionItemPatternIdentifiers.xml +++ b/xml/System.Windows.Automation/SelectionItemPatternIdentifiers.xml @@ -24,11 +24,11 @@ Contains values used as identifiers by . - . - + . + ]]> UI Automation Control Patterns Overview @@ -65,13 +65,13 @@ Identifies the event raised when an item is added to a collection of selected items. - call is a single selected item, then an must be raised instead. - - This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . - + call is a single selected item, then an must be raised instead. + + This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . + ]]> Implementing the UI Automation SelectionItem Control Pattern @@ -105,13 +105,13 @@ Identifies the event raised when an item is removed from a collection of selected items. - call is a single selected item, then an will be raised instead. - - This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . - + call is a single selected item, then an will be raised instead. + + This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . + ]]> Implementing the UI Automation SelectionItem Control Pattern @@ -145,13 +145,13 @@ Identifies the event that is raised when a single item is selected (causing all previously selected items to become deselected). - or a call is more than one selected item, then an or event is raised. - - This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . - + or a call is more than one selected item, then an or event is raised. + + This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . + ]]> Implementing the UI Automation SelectionItem Control Pattern @@ -185,11 +185,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation SelectionItem Control Pattern @@ -223,11 +223,11 @@ Identifies the pattern. - . - + . + ]]> Implementing the UI Automation SelectionItem Control Pattern @@ -261,11 +261,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation SelectionItem Control Pattern diff --git a/xml/System.Windows.Automation/SelectionPattern+SelectionPatternInformation.xml b/xml/System.Windows.Automation/SelectionPattern+SelectionPatternInformation.xml index 85f55c53806..38af0f52b89 100644 --- a/xml/System.Windows.Automation/SelectionPattern+SelectionPatternInformation.xml +++ b/xml/System.Windows.Automation/SelectionPattern+SelectionPatternInformation.xml @@ -57,21 +57,21 @@ if the control supports multiple selection; otherwise . - control pattern is obtained from an and subsequently used to retrieve property values. - + control pattern is obtained from an and subsequently used to retrieve property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet104"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -104,14 +104,14 @@ Retrieves all items in the selection container that are selected. The collection of selected items. The default is an empty array. - s representing the selected items in a selection container is obtained. - + s representing the selected items in a selection container is obtained. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet1025"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet1025"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet1025"::: + ]]> @@ -144,21 +144,21 @@ if the control requires at least one item to be selected; otherwise . - is `false`. However, after an item is selected, the control must always have at least one item selected. - - - -## Examples - In the following example, a control pattern is obtained from an and subsequently used to retrieve property values. - + is `false`. However, after an item is selected, the control must always have at least one item selected. + + + +## Examples + In the following example, a control pattern is obtained from an and subsequently used to retrieve property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet104"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104"::: + ]]> diff --git a/xml/System.Windows.Automation/SelectionPattern.xml b/xml/System.Windows.Automation/SelectionPattern.xml index cfbe5203269..749f14cb77c 100644 --- a/xml/System.Windows.Automation/SelectionPattern.xml +++ b/xml/System.Windows.Automation/SelectionPattern.xml @@ -24,11 +24,11 @@ Represents a control that acts as a container for a collection of selectable child items. The children of this element support the . - @@ -64,13 +64,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -102,19 +102,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -146,13 +146,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -183,21 +183,21 @@ Identifies the event that is raised when a selection in a container has changed significantly and requires sending more addition and removal events than the constant permits. - constant permits. - - This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - - - -## Examples - In the following example, an event listener is declared for the . - + constant permits. + + This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . + + + +## Examples + In the following example, an event listener is declared for the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet103"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet103"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet103"::: + ]]> @@ -228,19 +228,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -271,21 +271,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -316,21 +316,21 @@ Identifies the property that gets the selected items in a container. - . - - This property is not present in and must be retrieved by using or . - - - -## Examples - In the following example, a collection of s representing the selected items in a selection container is obtained. - + . + + This property is not present in and must be retrieved by using or . + + + +## Examples + In the following example, a collection of s representing the selected items in a selection container is obtained. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet102"::: + ]]> diff --git a/xml/System.Windows.Automation/StructureChangedEventArgs.xml b/xml/System.Windows.Automation/StructureChangedEventArgs.xml index 0230cd2f58a..b85c35cb0b6 100644 --- a/xml/System.Windows.Automation/StructureChangedEventArgs.xml +++ b/xml/System.Windows.Automation/StructureChangedEventArgs.xml @@ -60,31 +60,31 @@ The runtime identifier (ID) of the UI Automation element whose structure changed. Initializes a new instance of the class, specifying the type of change and the identifier (ID) of the element whose structure changed. - and not or . - - The following table describes the information in the event received by the for different structure changes. - -|`structureChangeType`|Event source|`runtimeId`| -|---------------------------|------------------|-----------------| -||The child that was added.|The child that was added.| -||The parent of the child that was removed.|The child that was removed.| -||The parent of the children that were added.|The parent of the children that were added.| -||The parent of the children that were removed.|The parent of the children that were removed.| -||The parent of the children that were invalidated.|The parent of the children that were invalidated| - - Custom controls might not be able to provide a meaningful value in `runtimeId`. For more information, see . - - - -## Examples - The following example shows how to construct and raise an event when children are added to, or removed from, a custom list box. - + and not or . + + The following table describes the information in the event received by the for different structure changes. + +|`structureChangeType`|Event source|`runtimeId`| +|---------------------------|------------------|-----------------| +||The child that was added.|The child that was added.| +||The parent of the child that was removed.|The child that was removed.| +||The parent of the children that were added.|The parent of the children that were added.| +||The parent of the children that were removed.|The parent of the children that were removed.| +||The parent of the children that were invalidated.|The parent of the children that were invalidated| + + Custom controls might not be able to provide a meaningful value in `runtimeId`. For more information, see . + + + +## Examples + The following example shows how to construct and raise an event when children are added to, or removed from, a custom list box. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/StructureChangedEventArgs/.ctor/ListFragment.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/FragmentProvider/VisualBasic/ListFragment.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/FragmentProvider/VisualBasic/ListFragment.vb" id="Snippet101"::: + ]]> @@ -118,13 +118,13 @@ Retrieves the UI Automation runtime identifier (ID) of the UI Automation element whose structure changed. The runtime ID of the UI Automation element whose structure changed. - . - - Custom controls might not provide a valid runtime identifier. - + . + + Custom controls might not provide a valid runtime identifier. + ]]> diff --git a/xml/System.Windows.Automation/SynchronizedInputPattern.xml b/xml/System.Windows.Automation/SynchronizedInputPattern.xml index 66383ad374d..b9efba22bdf 100644 --- a/xml/System.Windows.Automation/SynchronizedInputPattern.xml +++ b/xml/System.Windows.Automation/SynchronizedInputPattern.xml @@ -51,11 +51,11 @@ Stops listening for input. - @@ -85,11 +85,11 @@ Identifies the event raised when WPF discards input. - . - + . + ]]> @@ -119,11 +119,11 @@ Identifies the event raised when the input was received by an element other than the one currently listening for the input. - . - + . + ]]> @@ -153,11 +153,11 @@ Identifies the event raised when the input was received by the element currently listening for the input. - . - + . + ]]> @@ -187,13 +187,13 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . - + . + + The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . + ]]> @@ -227,13 +227,13 @@ The type of input to listen for. Designates that the provider start listening for input of the specified type. - event is raised. If the input is received by the automation element listening for that type, the event is raised; otherwise, the event is raised. - - After receiving the input, the provider stops listening and continues normally. - + event is raised. If the input is received by the automation element listening for that type, the event is raised; otherwise, the event is raised. + + After receiving the input, the provider stops listening and continues normally. + ]]> diff --git a/xml/System.Windows.Automation/TableItemPattern.xml b/xml/System.Windows.Automation/TableItemPattern.xml index ed2380154c7..8b427e1631e 100644 --- a/xml/System.Windows.Automation/TableItemPattern.xml +++ b/xml/System.Windows.Automation/TableItemPattern.xml @@ -71,7 +71,7 @@ . To get the current value of a property, get the property by using . + Cached property values must have been previously requested using a . To get the current value of a property, get the property by using . For information on the properties available and their use, see . @@ -112,7 +112,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - This property is not present in and must be retrieved by using or . + This property is not present in and must be retrieved by using or . @@ -159,7 +159,7 @@ with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + This pattern must be from an with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . For information on the properties available and their use, see . @@ -199,7 +199,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . @@ -245,7 +245,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - This property is not present in and must be retrieved by using or . + This property is not present in and must be retrieved by using or . diff --git a/xml/System.Windows.Automation/TablePattern.xml b/xml/System.Windows.Automation/TablePattern.xml index f43d36a40a7..6a723b40ab2 100644 --- a/xml/System.Windows.Automation/TablePattern.xml +++ b/xml/System.Windows.Automation/TablePattern.xml @@ -73,7 +73,7 @@ . Use to get the current value of a property. + Cached property values must have been previously requested using a . Use to get the current value of a property. For information on the properties available and their use, see . @@ -116,7 +116,7 @@ The order of the headers returned will be consistent within a provider, but not necessarily across providers. - This property is not present in and must be retrieved by using or . + This property is not present in and must be retrieved by using or . @@ -163,7 +163,7 @@ with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + This pattern must be from an with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . For information on the properties available and their use, see . @@ -203,7 +203,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . @@ -251,7 +251,7 @@ The order of the headers returned will be consistent within a provider, but not necessarily across providers. - This property is not present in and must be retrieved by using or . + This property is not present in and must be retrieved by using or . diff --git a/xml/System.Windows.Automation/TextPattern.xml b/xml/System.Windows.Automation/TextPattern.xml index 6b57a0c3e88..fbdd53d525f 100644 --- a/xml/System.Windows.Automation/TextPattern.xml +++ b/xml/System.Windows.Automation/TextPattern.xml @@ -69,7 +69,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -122,7 +122,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -174,7 +174,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -227,7 +227,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -280,7 +280,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is the language of the application user interface. @@ -386,7 +386,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is an `empty string`. @@ -438,7 +438,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -496,7 +496,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -551,7 +551,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -603,9 +603,9 @@ returns the degenerate text range (empty range) at the position of the system cursor (text insertion point). + If no text is selected, returns the degenerate text range (empty range) at the position of the system cursor (text insertion point). - If the system cursor (text insertion point) is not present, might return `null`. + If the system cursor (text insertion point) is not present, might return `null`. > [!NOTE] > Use the property to test if text selection or positioning of the text insertion point is supported by the control. @@ -702,7 +702,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is @@ -756,7 +756,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -810,7 +810,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -864,7 +864,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -916,7 +916,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `false`. @@ -968,7 +968,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `false`. @@ -1025,7 +1025,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `false`. @@ -1077,7 +1077,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `false`. @@ -1129,7 +1129,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `false`. @@ -1183,7 +1183,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1237,7 +1237,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1291,7 +1291,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1345,7 +1345,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1395,11 +1395,11 @@ returns `TextPattern.MixedAttributeValue` to indicate this variation instead of a collection of attribute values. + returns `TextPattern.MixedAttributeValue` to indicate this variation instead of a collection of attribute values. This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . @@ -1451,7 +1451,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -1503,7 +1503,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1557,7 +1557,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -1609,7 +1609,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . @@ -1710,7 +1710,7 @@ ## Remarks A text range that wraps a child object is returned if the screen coordinates are within the coordinates of an image, hyperlink, Microsoft Excel spreadsheet, or other embedded object. - Because hidden text is not ignored by , a degenerate range from the visible text closest to the given point is returned. + Because hidden text is not ignored by , a degenerate range from the visible text closest to the given point is returned. @@ -1755,7 +1755,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -1807,7 +1807,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -1901,7 +1901,7 @@ This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are an array of type . The default value is an `empty` array. @@ -1996,7 +1996,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . @@ -2096,7 +2096,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is `zero`. @@ -2148,7 +2148,7 @@ ## Remarks This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - UI Automation clients get the value of the attribute by calling . + UI Automation clients get the value of the attribute by calling . Values for this attribute are of type . The default value is . diff --git a/xml/System.Windows.Automation/TextPatternIdentifiers.xml b/xml/System.Windows.Automation/TextPatternIdentifiers.xml index f89725d41d2..35a4cb2a15a 100644 --- a/xml/System.Windows.Automation/TextPatternIdentifiers.xml +++ b/xml/System.Windows.Automation/TextPatternIdentifiers.xml @@ -994,7 +994,7 @@ returns `TextPattern.MixedAttributeValue` to indicate this variation instead of a collection of attribute values. + returns `TextPattern.MixedAttributeValue` to indicate this variation instead of a collection of attribute values. This identifier is used by UI Automation providers. UI Automation client applications should use the equivalent field in . diff --git a/xml/System.Windows.Automation/TogglePattern.xml b/xml/System.Windows.Automation/TogglePattern.xml index 47f54839a55..03ce10f99c3 100644 --- a/xml/System.Windows.Automation/TogglePattern.xml +++ b/xml/System.Windows.Automation/TogglePattern.xml @@ -56,13 +56,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -95,13 +95,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -132,21 +132,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101"::: + ]]> @@ -178,21 +178,21 @@ Cycles through the toggle states of an . - in this order: , and, if supported, . - - - -## Examples - In the following example, a control pattern is obtained from an and is subsequently used to toggle the . - + in this order: , and, if supported, . + + + +## Examples + In the following example, a control pattern is obtained from an and is subsequently used to toggle the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet102"::: + ]]> @@ -223,21 +223,21 @@ Identifies the property. - . - - An must cycle through its in this order: , and, if supported, . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + An must cycle through its in this order: , and, if supported, . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet100"::: + ]]> diff --git a/xml/System.Windows.Automation/TransformPattern.xml b/xml/System.Windows.Automation/TransformPattern.xml index 6cc44c0d843..19244d885bc 100644 --- a/xml/System.Windows.Automation/TransformPattern.xml +++ b/xml/System.Windows.Automation/TransformPattern.xml @@ -24,11 +24,11 @@ Represents a control that can be moved, resized, or rotated within a two-dimensional space. - @@ -63,13 +63,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -101,19 +101,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -144,19 +144,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -187,19 +187,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI Automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -231,13 +231,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -274,21 +274,21 @@ Absolute screen coordinates of the top of the control. Moves the control. - control pattern is obtained from an and subsequently used to move the . - + control pattern is obtained from an and subsequently used to move the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet103"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet103"::: + ]]> The property is false. @@ -320,21 +320,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -371,23 +371,23 @@ The new height of the window, in pixels. Resizes the control. - control pattern is obtained from an and subsequently used to resize the . - + control pattern is obtained from an and subsequently used to resize the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet104"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet104"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet104"::: + ]]> The property is false. @@ -423,21 +423,21 @@ The number of degrees to rotate the element. A positive number rotates clockwise; a negative number rotates counterclockwise. Rotates the control. - control pattern is obtained from an and subsequently used to rotate the . - + control pattern is obtained from an and subsequently used to rotate the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TransformPattern+TransformPatternInformation/CanMove/UIATransformPattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATransformPattern_snip/VisualBasic/UIATransformPattern_snippets.vb" id="Snippet102"::: + ]]> The property is false. diff --git a/xml/System.Windows.Automation/TransformPatternIdentifiers.xml b/xml/System.Windows.Automation/TransformPatternIdentifiers.xml index 9408e608850..7a46752ca9f 100644 --- a/xml/System.Windows.Automation/TransformPatternIdentifiers.xml +++ b/xml/System.Windows.Automation/TransformPatternIdentifiers.xml @@ -24,11 +24,11 @@ Contains values used as identifiers for . - . - + . + ]]> UI Automation Control Patterns Overview @@ -63,11 +63,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation Transform Control Pattern @@ -99,13 +99,13 @@ Identifies the property. - . - - When called on a control that supports split panes, this method can have the side effect of resizing other contiguous panes. - + . + + When called on a control that supports split panes, this method can have the side effect of resizing other contiguous panes. + ]]> Implementing the UI Automation Transform Control Pattern @@ -137,11 +137,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation Transform Control Pattern @@ -173,13 +173,13 @@ Identifies the control pattern. - . - - The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified UI Automation element. - + . + + The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified UI Automation element. + ]]> Implementing the UI Automation Transform Control Pattern diff --git a/xml/System.Windows.Automation/TreeWalker.xml b/xml/System.Windows.Automation/TreeWalker.xml index 724d9890a94..27753683b35 100644 --- a/xml/System.Windows.Automation/TreeWalker.xml +++ b/xml/System.Windows.Automation/TreeWalker.xml @@ -24,17 +24,17 @@ Provides methods and properties used to navigate the UI Automation tree. - objects arranged in a tree structure. - - Using the class, a client application can navigate the UI Automation tree by selecting a view of the tree and stepping from one to another in a specified direction using the , , , , and methods. - - Navigating the UI Automation tree using can result in cross-process calls and is not as efficient as locating an element using the or methods. - - If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. - + objects arranged in a tree structure. + + Using the class, a client application can navigate the UI Automation tree by selecting a view of the tree and stepping from one to another in a specified direction using the , , , , and methods. + + Navigating the UI Automation tree using can result in cross-process calls and is not as efficient as locating an element using the or methods. + + If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. + ]]> UI Automation Tree Overview @@ -69,21 +69,21 @@ The view of the UI Automation element tree that will navigate. Initializes a new instance of the class. - is used to navigate the element tree. - - If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. - - - -## Examples - The following example shows how you can construct a that navigates only among enabled elements. - + is used to navigate the element tree. + + If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread. + + + +## Examples + The following example shows how you can construct a that navigates only among enabled elements. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet174"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet174"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet174"::: + ]]> UI Automation Tree Overview @@ -153,19 +153,19 @@ Represents a predefined containing a view of elements in the tree that are marked as content controls. - being used to construct a tree view of elements in a subtree. The usage for is identical. - + being used to construct a tree view of elements in a subtree. The usage for is identical. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: + ]]> @@ -201,19 +201,19 @@ Represents a predefined containing a view of elements in the tree that are marked as controls. - being used to construct a tree view of elements in a subtree. - + being used to construct a tree view of elements in a subtree. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: + ]]> @@ -230,13 +230,13 @@ Retrieves the first child element of the specified . - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. + ]]> @@ -272,21 +272,21 @@ Retrieves the first child element of the specified . The first child element, or a null reference ( in Visual Basic) if there is no such element. - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. - - - -## Examples - The following example shows being used to construct a tree view of elements in a subtree. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. + + + +## Examples + The following example shows being used to construct a tree view of elements in a subtree. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: + ]]> UI Automation Tree Overview @@ -327,13 +327,13 @@ Retrieves the first child element of the specified and caches properties and patterns. The first child element, or a null reference ( in Visual Basic) if there is no such element. - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes. + ]]> UI Automation Tree Overview @@ -349,13 +349,13 @@ Retrieves the last child element of the specified . - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. + ]]> @@ -391,13 +391,13 @@ Retrieves the last child element of the specified . The that is the last child element, or a null reference ( in Visual Basic) if there is no such element. - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. + ]]> UI Automation Tree Overview @@ -438,13 +438,13 @@ Retrieves the last child element of the specified and caches properties and patterns. The last element, or a null reference ( in Visual Basic) if there is no such element. - can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. - + can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes. + ]]> UI Automation Tree Overview @@ -460,13 +460,13 @@ Retrieves the next sibling element of the specified . - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. + ]]> @@ -502,21 +502,21 @@ Retrieves the next sibling element of the specified . The next sibling element, or a null reference ( in Visual Basic) if there is no such element. - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. - - - -## Examples - The following example shows being used to construct a tree view of elements in a subtree. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. + + + +## Examples + The following example shows being used to construct a tree view of elements in a subtree. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: + ]]> UI Automation Tree Overview @@ -557,13 +557,13 @@ Retrieves the next sibling element of the specified and caches properties and patterns. The next sibling element, or a null reference ( in Visual Basic) if there is no such element. - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes. + ]]> UI Automation Tree Overview @@ -579,11 +579,11 @@ Retrieves the parent element of the specified . - tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes. - + tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes. + ]]> @@ -619,14 +619,14 @@ Retrieves the parent element of the specified . The parent element, or a null reference ( in Visual Basic) if the specified element is the root element in the tree, or if the parent element is not visible in the current view. - being used to find the window element that contains a specified element. - + being used to find the window element that contains a specified element. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/Automation/AddStructureChangedEventHandler/FocusTracker.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFocusTracker_snip/VisualBasic/FocusTracker.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFocusTracker_snip/VisualBasic/FocusTracker.vb" id="Snippet102"::: + ]]> UI Automation Tree Overview @@ -667,11 +667,11 @@ Retrieves the parent element of the specified and caches properties and patterns. The parent element, or a null reference ( in Visual Basic) if the specified element is the root element in the tree, or the parent element is not visible in this view. - tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes. - + tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes. + ]]> UI Automation Tree Overview @@ -687,13 +687,13 @@ Retrieves the previous sibling of the specified . - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. + ]]> @@ -729,13 +729,13 @@ Retrieves the previous sibling of the specified . The previous sibling element, or a null reference ( in Visual Basic) if there is no such element. - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. + ]]> UI Automation Tree Overview @@ -776,13 +776,13 @@ Retrieves the previous sibling of the specified and caches properties and patterns. The previous sibling element, or a null reference ( in Visual Basic) if there is no such element. - can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. - - The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. - + can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree. + + The structure of the tree changes as the visible user interface (UI) elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes. + ]]> UI Automation Tree Overview @@ -798,13 +798,13 @@ Retrieves the ancestor element nearest to the specified in the tree view used by this instance of . - object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. - - This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. - + object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. + + This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. + ]]> @@ -840,13 +840,13 @@ Retrieves the node itself, if it satisfies the , or the nearest parent or ancestor node that satisfies the . The nearest in the current view. If the navigation up the ancestor chain reaches the root element, the root element is returned. - object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. - - This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. - + object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. + + This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. + ]]> UI Automation Tree Overview @@ -887,13 +887,13 @@ Retrieves the node itself, if it satisfies the , or the nearest parent or ancestor node that satisfies the , and caches properties and patterns. The nearest in the current view. If the navigation up the ancestor chain reaches the root element, the root element is returned. - object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. - - This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. - + object is reached. If the root element is reached, the root element is returned even if it does not satisfy the view condition. + + This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved. + ]]> UI Automation Tree Overview @@ -927,19 +927,19 @@ Represents a predefined containing a view of all the elements in the tree. - being used to construct a tree view of elements in a subtree. The usage for is identical. - + being used to construct a tree view of elements in a subtree. The usage for is identical. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet171"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet171"::: + ]]> UI Automation Tree Overview diff --git a/xml/System.Windows.Automation/ValuePattern+ValuePatternInformation.xml b/xml/System.Windows.Automation/ValuePattern+ValuePatternInformation.xml index 23e34f84ed7..307276c9662 100644 --- a/xml/System.Windows.Automation/ValuePattern+ValuePatternInformation.xml +++ b/xml/System.Windows.Automation/ValuePattern+ValuePatternInformation.xml @@ -58,19 +58,19 @@ if the value is read-only; if it can be modified. - set to `true` and its set to `false` before the client attempts a call to . - - - -## Examples - In the following example, an that supports the control pattern has its set to a user-specified value. - + set to `true` and its set to `false` before the client attempts a call to . + + + +## Examples + In the following example, an that supports the control pattern has its set to a user-specified value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet103"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet103"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet103"::: + ]]> TextPattern Insert Text Sample @@ -103,23 +103,23 @@ Gets the value of the UI Automation element. The value of the UI Automation element as a string. The default is an empty string. - . However, multi-line edit controls do not support the control pattern. - - To retrieve the textual contents of multi-line edit controls the controls must support the control pattern. However, does not support setting the value of a control. - - does not support the retrieval of formatting information or substring values. The control pattern must be used in these scenarios. - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . However, multi-line edit controls do not support the control pattern. + + To retrieve the textual contents of multi-line edit controls the controls must support the control pattern. However, does not support setting the value of a control. + + does not support the retrieval of formatting information or substring values. The control pattern must be used in these scenarios. + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet102"::: + ]]> TextPattern Insert Text Sample diff --git a/xml/System.Windows.Automation/ValuePattern.xml b/xml/System.Windows.Automation/ValuePattern.xml index ae0dd2b4843..09ab4386f7a 100644 --- a/xml/System.Windows.Automation/ValuePattern.xml +++ b/xml/System.Windows.Automation/ValuePattern.xml @@ -57,13 +57,13 @@ Gets the cached UI Automation property values for this . The cached property values. - . To get the value of a property at the current point in time, get the property by using . - - For information on the properties available and their use, see . - + . To get the value of a property at the current point in time, get the property by using . + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -97,13 +97,13 @@ Gets the current UI Automation property values for this . The current property values. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> TextPattern Insert Text Sample @@ -135,21 +135,21 @@ Identifies the property. - . - - A control should have its set to `true` and its set to `false` before a client attempts a call to . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of UI automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + A control should have its set to `true` and its set to `false` before a client attempts a call to . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of UI automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet100"::: + ]]> TextPattern Insert Text Sample @@ -181,21 +181,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet101"::: + ]]> TextPattern Insert Text Sample @@ -231,19 +231,19 @@ Value to set. The UI Automation provider is responsible for converting the value to the appropriate data type. Sets the value of the control. - . However, multi-line edit controls do not support the ; instead they provide access to their content through the control pattern. - - - -## Examples - In the following example, an that supports the control pattern has its set to a user-specified value. - + . However, multi-line edit controls do not support the ; instead they provide access to their content through the control pattern. + + + +## Examples + In the following example, an that supports the control pattern has its set to a user-specified value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet103"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet103"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet103"::: + ]]> The control is read-only. @@ -277,19 +277,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. - + . + + + +## Examples + In the following example, a object obtained from a target control is passed into a function that retrieves the current property values. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/ValuePattern+ValuePatternInformation/IsReadOnly/UIAValuePattern_snippets.cs" id="Snippet102"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet102"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAValuePattern_snip/VisualBasic/UIAValuePattern_snippets.vb" id="Snippet102"::: + ]]> TextPattern Insert Text Sample diff --git a/xml/System.Windows.Automation/ValuePatternIdentifiers.xml b/xml/System.Windows.Automation/ValuePatternIdentifiers.xml index 30bbe3247c0..0c52b4a924c 100644 --- a/xml/System.Windows.Automation/ValuePatternIdentifiers.xml +++ b/xml/System.Windows.Automation/ValuePatternIdentifiers.xml @@ -24,11 +24,11 @@ Contains values used as identifiers for . - . - + . + ]]> UI Automation Control Patterns Overview @@ -63,13 +63,13 @@ Identifies the property. - . - - A control should have its set to `true` and its set to `false` before allowing a call to . - + . + + A control should have its set to `true` and its set to `false` before allowing a call to . + ]]> Implementing the UI Automation Value Control Pattern @@ -101,13 +101,13 @@ Identifies the control pattern. - . - - The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified UI Automation element. - + . + + The pattern identifier (ID) is passed to methods such as to retrieve the control pattern of interest from the specified UI Automation element. + ]]> Implementing the UI Automation Value Control Pattern @@ -139,11 +139,11 @@ Identifies the property. - . - + . + ]]> Implementing the UI Automation Value Control Pattern diff --git a/xml/System.Windows.Automation/VirtualizedItemPattern.xml b/xml/System.Windows.Automation/VirtualizedItemPattern.xml index fb3f388c438..4dea57714c2 100644 --- a/xml/System.Windows.Automation/VirtualizedItemPattern.xml +++ b/xml/System.Windows.Automation/VirtualizedItemPattern.xml @@ -50,13 +50,13 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . - + . + + The pattern identifier is passed to methods, such as , to retrieve the control pattern of interest from the specified . + ]]> diff --git a/xml/System.Windows.Automation/WindowClosedEventArgs.xml b/xml/System.Windows.Automation/WindowClosedEventArgs.xml index 1c3bf8936a8..fc413548db0 100644 --- a/xml/System.Windows.Automation/WindowClosedEventArgs.xml +++ b/xml/System.Windows.Automation/WindowClosedEventArgs.xml @@ -24,18 +24,18 @@ Contains information about the event that is raised when a window is closed. - , specifying in the `eventId` parameter and supplying an UI Automation event handler that takes a parameter. - - When your application receives a window-closed event, the `sender` parameter of the event handler cannot be used to obtain information about the window that has closed, because the corresponding UI Automation element is no longer valid. - - - -## Examples - For example code, see . - + , specifying in the `eventId` parameter and supplying an UI Automation event handler that takes a parameter. + + When your application receives a window-closed event, the `sender` parameter of the event handler cannot be used to obtain information about the window that has closed, because the corresponding UI Automation element is no longer valid. + + + +## Examples + For example code, see . + ]]> UI Automation Events Overview @@ -99,19 +99,19 @@ Retrieves the UI Automation runtime identifier (ID) associated with this event. The UI Automation runtime ID of the window on which the event was raised. - to match the window with a known identifier. - - - -## Examples - In the following example, the handler for the window-closed event ascertains whether the runtime ID of the closed window is in a list of the IDs of open windows. If the runtime ID is present, it is removed from the list. - + to match the window with a known identifier. + + + +## Examples + In the following example, the handler for the window-closed event ascertains whether the runtime ID of the closed window is in a list of the IDs of open windows. If the runtime ID is present, it is removed from the list. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/Automation/AddStructureChangedEventHandler/FocusTracker.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFocusTracker_snip/VisualBasic/FocusTracker.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAFocusTracker_snip/VisualBasic/FocusTracker.vb" id="Snippet101"::: + ]]> diff --git a/xml/System.Windows.Automation/WindowPattern.xml b/xml/System.Windows.Automation/WindowPattern.xml index 3cac5b706b4..3a01efb6ef8 100644 --- a/xml/System.Windows.Automation/WindowPattern.xml +++ b/xml/System.Windows.Automation/WindowPattern.xml @@ -24,11 +24,11 @@ Represents a control that provides fundamental window-based functionality within a traditional graphical user interface (GUI). - @@ -63,13 +63,13 @@ Gets the cached UI Automation property values for this . A structure containing the cached UI Automation property values for the control pattern. - . Use to get the current value of a property. - - For information on the properties available and their use, see . - + . Use to get the current value of a property. + + For information on the properties available and their use, see . + ]]> The requested property is not in the cache. @@ -101,19 +101,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -144,19 +144,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -188,21 +188,21 @@ Attempts to close the current window. - control pattern is obtained from an and is subsequently used to close the . - + control pattern is obtained from an and is subsequently used to close the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet102"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet102"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet102"::: + ]]> The control is unable to perform the requested action. @@ -236,13 +236,13 @@ Gets the current UI Automation property values for this . A structure containing the current UI Automation property values for the control pattern. - with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . - - For information on the properties available and their use, see . - + with an reference in order to get current values. If the was obtained using , it contains only cached data, and attempting to get the current value of any property raises an exception. Use to get the cached value of a property that was previously specified using a . + + For information on the properties available and their use, see . + ]]> @@ -273,19 +273,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -316,19 +316,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -359,21 +359,21 @@ Identifies the control pattern. - . - - The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . - - - -## Examples - In the following example, a control pattern is obtained from an . - + . + + The pattern identifier is passed to methods such as to retrieve the control pattern of interest from the specified . + + + +## Examples + In the following example, a control pattern is obtained from an . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: + ]]> @@ -408,16 +408,16 @@ The requested of the window. Changes the of the window. - control pattern is obtained from an and is subsequently used to specify the visual state of the . - + control pattern is obtained from an and is subsequently used to specify the visual state of the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet103"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet103"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet103"::: + ]]> A control does not support a requested behavior. @@ -455,21 +455,21 @@ if the window has entered the idle state; if the timeout occurred. - . - - The implementation is dependent on the underlying application framework; therefore this method may return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle. - - - -## Examples - In the following example, a control pattern is obtained from an and uses to confirm the element is ready for user interaction within a reasonable amount of time. - + . + + The implementation is dependent on the underlying application framework; therefore this method may return some time after the window is ready for user input. The calling code should not rely on this method to ascertain exactly when the window has become idle. + + + +## Examples + In the following example, a control pattern is obtained from an and uses to confirm the element is ready for user interaction within a reasonable amount of time. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet101"::: + ]]> The parameter passed in is not a valid number. @@ -501,21 +501,21 @@ Identifies the event that is raised when a window is closed. - from a cached object since a window is removed from the UI Automation control view structure immediately upon being closed. - - This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . - - - -## Examples - In the following example, event listeners are declared and an delegate is specified for and events. - + from a cached object since a window is removed from the UI Automation control view structure immediately upon being closed. + + This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in . + + + +## Examples + In the following example, event listeners are declared and an delegate is specified for and events. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -547,19 +547,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> @@ -590,19 +590,19 @@ Identifies the event that is raised when a window is opened. - . - - - -## Examples - In the following example, event listeners are declared and an delegate is specified for and events. - + . + + + +## Examples + In the following example, event listeners are declared and an delegate is specified for and events. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet104"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet104"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet104"::: + ]]> @@ -633,19 +633,19 @@ Identifies the property. - . - - - -## Examples - In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. - + . + + + +## Examples + In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/WindowPattern+WindowPatternInformation/CanMaximize/UIAWindowPattern_snippets.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAWindowPattern_snip/VisualBasic/UIAWindowPattern_snippets.vb" id="Snippet100"::: + ]]> diff --git a/xml/System.Windows.Baml2006/Baml2006Reader.xml b/xml/System.Windows.Baml2006/Baml2006Reader.xml index 18efbafc586..852ead1a691 100644 --- a/xml/System.Windows.Baml2006/Baml2006Reader.xml +++ b/xml/System.Windows.Baml2006/Baml2006Reader.xml @@ -27,17 +27,17 @@ Processes XAML in optimized BAML form and produces a XAML node stream. - reader class constitutes much of the public API surface that a WPF application developer has for interacting with BAML. - - The XAML optimized to BAML form may need to be localized. Localization of XAML and possible tools pathways for doing so is not discussed in this topic. See [Globalization for WPF](/dotnet/framework/wpf/advanced/globalization-for-wpf). - - uses an internally implemented XAML schema context. This schema context provides the logic necessary for looking up the types in BAML form, including referencing the optimizations and tokens that are inherent in BAML. - - The main scenario for is to use it as the implementation that you pass to a call to . - + reader class constitutes much of the public API surface that a WPF application developer has for interacting with BAML. + + The XAML optimized to BAML form may need to be localized. Localization of XAML and possible tools pathways for doing so is not discussed in this topic. See [Globalization for WPF](/dotnet/framework/wpf/advanced/globalization-for-wpf). + + uses an internally implemented XAML schema context. This schema context provides the logic necessary for looking up the types in BAML form, including referencing the optimizations and tokens that are inherent in BAML. + + The main scenario for is to use it as the implementation that you pass to a call to . + ]]> @@ -139,11 +139,11 @@ Reader settings. Initializes a new instance of the class based on an input stream and reader settings. - uses an internal settings class override. However you can pass the information that is permitted by the base class, and your passed settings are internally upgraded to or merged into the internal settings. Passing `null` for `xamlReaderSettings` of this signature throws an exception. If you have no special settings to report, use the signature. - + uses an internal settings class override. However you can pass the information that is permitted by the base class, and your passed settings are internally upgraded to or merged into the internal settings. Passing `null` for `xamlReaderSettings` of this signature throws an exception. If you have no special settings to report, use the signature. + ]]> @@ -329,11 +329,11 @@ if a node is available; otherwise, . - . - + . + ]]> Reader was disposed during traversal. diff --git a/xml/System.Windows.Controls.Primitives/BulletDecorator.xml b/xml/System.Windows.Controls.Primitives/BulletDecorator.xml index e3cbd73df47..ec350014eaf 100644 --- a/xml/System.Windows.Controls.Primitives/BulletDecorator.xml +++ b/xml/System.Windows.Controls.Primitives/BulletDecorator.xml @@ -27,9 +27,9 @@ has two content properties: and . The property defines the to use as a bullet. The property defines a that visually aligns with the bullet. + has two content properties: and . The property defines the to use as a bullet. The property defines a that visually aligns with the bullet. - A always aligns with the first line of text when the object is a . If the object is not a , the aligns to the center of the object. For more information about layout of a , see [How to: Create a BulletDecorator](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms753295(v=vs.90)). + A always aligns with the first line of text when the object is a . If the object is not a , the aligns to the center of the object. For more information about layout of a , see [How to: Create a BulletDecorator](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms753295(v=vs.90)). The following illustration shows examples of controls. @@ -113,7 +113,7 @@ method determines the size and position of the and the objects. The is aligned vertically with the first line of the content. + The method determines the size and position of the and the objects. The is aligned vertically with the first line of the content. ]]> @@ -149,7 +149,7 @@ property defines the to use to fill the area within the . For some parent layout elements, the area that is defined for the may extend beyond its and content. For example, if the is the single child of a cell in a control, the property applies to the whole cell. This occurs because the content in a cell is stretched in all directions to fill the cell, by default. However, if you set the property to for the , the property only affects the actual content area of the . Alternatively, you can enclose the in a element. + The property defines the to use to fill the area within the . For some parent layout elements, the area that is defined for the may extend beyond its and content. For example, if the is the single child of a cell in a control, the property applies to the whole cell. This occurs because the content in a cell is stretched in all directions to fill the cell, by default. However, if you set the property to for the , the property only affects the actual content area of the . Alternatively, you can enclose the in a element. ## Dependency Property Information @@ -157,7 +157,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -237,9 +237,9 @@ property is a content property of the control and defines the to display as a bullet for the object. + The property is a content property of the control and defines the to display as a bullet for the object. - The bullet that is defined by setting the property to a is the first visual element in a control. The single element is the second visual element. + The bullet that is defined by setting the property to a is the first visual element in a control. The single element is the second visual element. ## XAML Property Element Usage @@ -299,7 +299,7 @@ are the and the properties. + The visual child elements of a are the and the properties. ]]> @@ -341,7 +341,7 @@ control include the and . If you set both properties, they are enumerated in the following order: , . + The logical child elements for a control include the and . If you set both properties, they are enumerated in the following order: , . The number of visual child elements is the same as the number of logical child elements. @@ -416,7 +416,7 @@ structure that is sized for the content. This rectangular structure is displayed with the specified color and no border. + This method creates a structure that is sized for the content. This rectangular structure is displayed with the specified color and no border. ]]> @@ -452,7 +452,7 @@ can be 0, 1, or 2. If either the or a element is defined, the is 1. If both the and a element are defined, the is 2. + The can be 0, 1, or 2. If either the or a element is defined, the is 1. If both the and a element are defined, the is 2. The number of visual child elements is the same as the number of logical child elements. diff --git a/xml/System.Windows.Controls.Primitives/ButtonBase.xml b/xml/System.Windows.Controls.Primitives/ButtonBase.xml index 16e549d1db3..ec72671fb79 100644 --- a/xml/System.Windows.Controls.Primitives/ButtonBase.xml +++ b/xml/System.Windows.Controls.Primitives/ButtonBase.xml @@ -42,9 +42,9 @@ event to respond when the user clicks a . The user can raise the event by using an or by pressing ENTER or the SPACEBAR when the control has focus. When the user presses the SPACEBAR, the control sets to `true` and captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but it does raise the event. + Handle the event to respond when the user clicks a . The user can raise the event by using an or by pressing ENTER or the SPACEBAR when the control has focus. When the user presses the SPACEBAR, the control sets to `true` and captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but it does raise the event. - The sets the attached property to `true`. + The sets the attached property to `true`. The sets the property to `false`. @@ -120,9 +120,9 @@ event by using an or by pressing ENTER or the SPACEBAR when the control has focus. When the user presses the SPACEBAR, the control sets to `true` and captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but it does raise the event. + The user can raise the event by using an or by pressing ENTER or the SPACEBAR when the control has focus. When the user presses the SPACEBAR, the control sets to `true` and captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but it does raise the event. - The marks the event as handled in the method and raises the event. Hence, the event will never occur for a control that inherits from . Instead, attach an event handler to the event, or call with `handledEventsToo` set to `true`. + The marks the event as handled in the method and raises the event. Hence, the event will never occur for a control that inherits from . Instead, attach an event handler to the event, or call with `handledEventsToo` set to `true`. ## Routed Event Information @@ -385,7 +385,7 @@ in code might require a new or existing object instance. Setting in markup might require property element syntax, where the object element filling the property element syntax is a new element of the type expected by that command. Alternatively, setting in markup might require a reference through a markup extension to an existing object (typically these references are made with [Binding Markup Extension](/dotnet/framework/wpf/advanced/binding-markup-extension) or [StaticResource Markup Extension](/dotnet/framework/wpf/advanced/staticresource-markup-extension)). + Most existing commands from the command libraries do not use a command parameter. Of the commands that do use a command parameter, most of these take a parameter with some primitive type value, such as an integer or a string. However, it is possible to create a custom command where that command expects a nonprimitive type as its command parameter. For a custom command case like this, setting in code might require a new or existing object instance. Setting in markup might require property element syntax, where the object element filling the property element syntax is a new element of the type expected by that command. Alternatively, setting in markup might require a reference through a markup extension to an existing object (typically these references are made with [Binding Markup Extension](/dotnet/framework/wpf/advanced/binding-markup-extension) or [StaticResource Markup Extension](/dotnet/framework/wpf/advanced/staticresource-markup-extension)). ## XAML Attribute Usage @@ -397,7 +397,7 @@ ## XAML Values *commandParameter* - A value of the same type as the particular command specified in the property expects. If you use an existing command library command, see that command library's documentation for XAML usage information, including which type of the command expects. If you use a custom command, see Remarks. + A value of the same type as the particular command specified in the property expects. If you use an existing command library command, see that command library's documentation for XAML usage information, including which type of the command expects. If you use a custom command, see Remarks. ## Dependency Property Information @@ -645,9 +645,9 @@ is the state of a button that indicates the left mouse button or SPACEBAR is pressed over the button. When is `true`, the control captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but is does raise the event. + is the state of a button that indicates the left mouse button or SPACEBAR is pressed over the button. When is `true`, the control captures the mouse. As a result, the control will raise mouse events such as and . Note that using the or ENTER does not change or capture the mouse, but is does raise the event. - Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Dependency Property Information @@ -729,7 +729,7 @@ is `true`, this method calls the base implementation, which gives this control focus. Otherwise, this method raises the event. + If is `true`, this method calls the base implementation, which gives this control focus. Otherwise, this method raises the event. ]]> @@ -765,7 +765,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -839,11 +839,11 @@ event as handled by setting the property of the event data to `true` when is not set to and one of the following cases are true: + This implementation marks the event as handled by setting the property of the event data to `true` when is not set to and one of the following cases are true: - The user presses the SPACEBAR. -- The user presses ENTER and is `true` for this control. +- The user presses ENTER and is `true` for this control. In all other cases, this implementation does not change the handled state (the property) of the event data. @@ -1003,7 +1003,7 @@ is set to , this implementation marks the event as handled by setting the property of the event data to `true` and raises the event. + When is set to , this implementation marks the event as handled by setting the property of the event data to `true` and raises the event. ]]> @@ -1045,7 +1045,7 @@ event as handled by setting the property of the event data to `true` when is set to . + This implementation marks the event as handled by setting the property of the event data to `true` when is set to . ]]> @@ -1087,9 +1087,9 @@ event as handled by setting the property of the event data to `true` when is not set to . To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. + This implementation marks the event as handled by setting the property of the event data to `true` when is not set to . To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. - When is set to , this method raises the event. + When is set to , this method raises the event. ]]> @@ -1131,9 +1131,9 @@ event as handled by setting the property of the event data to `true` when is not set to . To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. + This implementation marks the event as handled by setting the property of the event data to `true` when is not set to . To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. - When is set to is is `true`, this method raises the event. + When is set to is is `true`, this method raises the event. ]]> @@ -1175,7 +1175,7 @@ event as handled by setting the property of the event data to `true` when is not set to and is `true`. To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. + This implementation marks the event as handled by setting the property of the event data to `true` when is not set to and is `true`. To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. ]]> @@ -1217,7 +1217,7 @@ method of the . + Overrides the method of the . ]]> diff --git a/xml/System.Windows.Controls.Primitives/CalendarButton.xml b/xml/System.Windows.Controls.Primitives/CalendarButton.xml index d211f716558..b59fd7ab5b2 100644 --- a/xml/System.Windows.Controls.Primitives/CalendarButton.xml +++ b/xml/System.Windows.Controls.Primitives/CalendarButton.xml @@ -142,7 +142,7 @@ of a calendar is , it displays the year before and after the current decade. For example, a calendar that shows the decade for 2000 through 2009 also displays buttons for the years 1999 and 2010. However, the property is set to `true` for the buttons that represent those years. + When the of a calendar is , it displays the year before and after the current decade. For example, a calendar that shows the decade for 2000 through 2009 also displays buttons for the years 1999 and 2010. However, the property is set to `true` for the buttons that represent those years. ]]> diff --git a/xml/System.Windows.Controls.Primitives/CalendarDayButton.xml b/xml/System.Windows.Controls.Primitives/CalendarDayButton.xml index fd6570d3fcb..adc0ecc0771 100644 --- a/xml/System.Windows.Controls.Primitives/CalendarDayButton.xml +++ b/xml/System.Windows.Controls.Primitives/CalendarDayButton.xml @@ -198,7 +198,7 @@ of a calendar is , it might display days that are not in that month. For example, a calendar that shows March 2009 also displays the days February 22 through February 28 and April 1 through April 4. Because those dates are not in the month of March, the property is set to `true` for the buttons that represent those days. + When the of a calendar is , it might display days that are not in that month. For example, a calendar that shows March 2009 also displays the days February 22 through February 28 and April 1 through April 4. Because those dates are not in the month of March, the property is set to `true` for the buttons that represent those days. ]]> diff --git a/xml/System.Windows.Controls.Primitives/DataGridColumnHeader.xml b/xml/System.Windows.Controls.Primitives/DataGridColumnHeader.xml index 3c13da196bd..984f2d201e5 100644 --- a/xml/System.Windows.Controls.Primitives/DataGridColumnHeader.xml +++ b/xml/System.Windows.Controls.Primitives/DataGridColumnHeader.xml @@ -365,11 +365,11 @@ Builds the visual tree for the column header when a new template is applied. - method. - + method. + ]]> @@ -402,11 +402,11 @@ Raises the event and initiates sorting. - diff --git a/xml/System.Windows.Controls.Primitives/DataGridRowHeader.xml b/xml/System.Windows.Controls.Primitives/DataGridRowHeader.xml index 19eb90f39ca..59882fda8e3 100644 --- a/xml/System.Windows.Controls.Primitives/DataGridRowHeader.xml +++ b/xml/System.Windows.Controls.Primitives/DataGridRowHeader.xml @@ -201,11 +201,11 @@ Builds the visual tree for the row header when a new template is applied. - method. - + method. + ]]> @@ -239,11 +239,11 @@ Raises the event and initiates row selection or drag operations. - diff --git a/xml/System.Windows.Controls.Primitives/DataGridRowsPresenter.xml b/xml/System.Windows.Controls.Primitives/DataGridRowsPresenter.xml index 610888d9f95..7eec1d67735 100644 --- a/xml/System.Windows.Controls.Primitives/DataGridRowsPresenter.xml +++ b/xml/System.Windows.Controls.Primitives/DataGridRowsPresenter.xml @@ -123,17 +123,17 @@ The event data. Raises the event for rows that have scrolled out of view. - class maintains instances only for data items that are currently on display within the user interface. When rows are scrolled out of view, the instances become available for garbage collection. - - This method override cancels cleanup for rows that have validation errors. You can override this method or handle the event to provide your own logic for canceling the cleanup of particular rows. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + class maintains instances only for data items that are currently on display within the user interface. When rows are scrolled out of view, the instances become available for garbage collection. + + This method override cancels cleanup for rows that have validation errors. You can override this method or handle the event to provide your own logic for canceling the cleanup of particular rows. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> diff --git a/xml/System.Windows.Controls.Primitives/DocumentPageView.xml b/xml/System.Windows.Controls.Primitives/DocumentPageView.xml index c25fbc901f4..78d1d4a5439 100644 --- a/xml/System.Windows.Controls.Primitives/DocumentPageView.xml +++ b/xml/System.Windows.Controls.Primitives/DocumentPageView.xml @@ -131,10 +131,10 @@ after finished using each instance. After is called, the is released for garbage collection and should no longer be referenced by the application. After calling and being released, the garbage collector can reclaim the memory and resources. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + Call after finished using each instance. After is called, the is released for garbage collection and should no longer be referenced by the application. After calling and being released, the garbage collector can reclaim the memory and resources. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). > [!NOTE] -> Always call as the final call to release each instance. If is not called, the resources the is using will not be freed until the garbage collector later calls the page viewer's method. +> Always call as the final call to release each instance. If is not called, the resources the is using will not be freed until the garbage collector later calls the page viewer's method. ]]> @@ -240,7 +240,7 @@ returns any services that the provides if the implements . + returns any services that the provides if the implements . ]]> @@ -280,7 +280,7 @@ -1. + `index` must be between 0 and -1. ]]> @@ -523,9 +523,9 @@ is zero-based: 0 is the first page, 1 is the second page, and so on. + is zero-based: 0 is the first page, 1 is the second page, and so on. - No content is displayed if is set to a negative number. + No content is displayed if is set to a negative number. ## Dependency Property Information @@ -533,7 +533,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -605,7 +605,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -649,7 +649,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Primitives/DocumentViewerBase.xml b/xml/System.Windows.Controls.Primitives/DocumentViewerBase.xml index 88842232f66..3b878d88693 100644 --- a/xml/System.Windows.Controls.Primitives/DocumentViewerBase.xml +++ b/xml/System.Windows.Controls.Primitives/DocumentViewerBase.xml @@ -111,7 +111,7 @@ + ]]> @@ -227,7 +227,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -383,7 +383,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -544,7 +544,7 @@ object (in the collection) that includes the attached property with a value of `true`. For more information, see . + The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ]]> @@ -583,7 +583,7 @@ provides a viewport for a particular page of content (represented by an underlying ). The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . + A provides a viewport for a particular page of content (represented by an underlying ). The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ]]> @@ -671,7 +671,7 @@ method), this method does nothing. + If *pageNumber* specifies an invalid page to go to (as indicated by the method), this method does nothing. ]]> @@ -738,11 +738,11 @@ in the collection represents master page. The master page corresponds to the page that is currently active (being displayed) in the viewer. + This attached property is used to indicate which in the collection represents master page. The master page corresponds to the page that is currently active (being displayed) in the viewer. - Typically, no more than one member of the collection is marked as the master page. If more than one member of the collection is marked as the master page, then the first indicated in the logical tree (depth-first) is designated the active master. If no members of the collection are marked as the master page, then the master page defaults to the first member of the collection. + Typically, no more than one member of the collection is marked as the master page. If more than one member of the collection is marked as the master page, then the first indicated in the logical tree (depth-first) is designated the active master. If no members of the collection are marked as the master page, then the master page defaults to the first member of the collection. - Use the method to set and attach this property to a specified element (dependency object). Use the method to read the value of this attached property from a specified element. + Use the method to set and attach this property to a specified element (dependency object). Use the method to read the value of this attached property from a specified element. ## Dependency Property Information @@ -896,7 +896,7 @@ object (in the collection) that includes the attached property with a value of `true`. For more information, see . + The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ## Dependency Property Information @@ -967,7 +967,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -1045,9 +1045,9 @@ is called. + This method is invoked whenever is called. - This method overrides . + This method overrides . ]]> @@ -1127,7 +1127,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1164,7 +1164,7 @@ . + This method overrides . ]]> @@ -1269,7 +1269,7 @@ routed command causes the viewer to jump to the first page in the current . + The routed command causes the viewer to jump to the first page in the current . ]]> @@ -1312,9 +1312,9 @@ routed command cause the viewer to jump to an indicated page number in the current . The method indicates whether or not a specified page number is a valid page to jump to in the current document. + The routed command cause the viewer to jump to an indicated page number in the current . The method indicates whether or not a specified page number is a valid page to jump to in the current document. - If *pageNumber* specifies an invalid page to go to (as indicated by the method), this method does nothing. + If *pageNumber* specifies an invalid page to go to (as indicated by the method), this method does nothing. ]]> @@ -1354,7 +1354,7 @@ routed command causes the viewer to jump to the last page in the current . + The routed command causes the viewer to jump to the last page in the current . ]]> @@ -1400,7 +1400,7 @@ object (in the collection) that includes the attached property with a value of `true`. For more information, see . + The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ]]> @@ -1436,7 +1436,7 @@ routed command causes the viewer to jump to the next page (if available) in the current . The property indicates whether or not there is a next page to go to in the current document. + The routed command causes the viewer to jump to the next page (if available) in the current . The property indicates whether or not there is a next page to go to in the current document. ]]> @@ -1505,7 +1505,7 @@ routed command causes the viewer to jump to the next page (if available) in the current . The property indicates whether or not there is a previous page to go to in the current document. + The routed command causes the viewer to jump to the next page (if available) in the current . The property indicates whether or not there is a previous page to go to in the current document. ]]> @@ -1545,7 +1545,7 @@ command is invoked. + This method is called whenever the command is invoked. ]]> @@ -1656,7 +1656,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -1706,7 +1706,7 @@ ## Remarks A provides a viewport for a particular page of content (represented by an underlying ). The set of objects represented by the property is used by the viewer in order to display content. - The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . + The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ]]> @@ -1863,7 +1863,7 @@ object (in the collection) that includes the attached property with a value of `true`. For more information, see . + The master page corresponds to the object (in the collection) that includes the attached property with a value of `true`. For more information, see . ]]> diff --git a/xml/System.Windows.Controls.Primitives/GeneratorPosition.xml b/xml/System.Windows.Controls.Primitives/GeneratorPosition.xml index 89bad176545..07ca41779ca 100644 --- a/xml/System.Windows.Controls.Primitives/GeneratorPosition.xml +++ b/xml/System.Windows.Controls.Primitives/GeneratorPosition.xml @@ -25,29 +25,29 @@ is used to describe the position of an item that is managed by . - is used by . - - - -## Examples - The following example illustrates how to use to start generating forward from the beginning of an item list. - + is used by . + + + +## Examples + The following example illustrates how to use to start generating forward from the beginning of an item list. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/GeneratorPosition/Overview/Window1.xaml.cs" id="Snippetgenerateforwardfrombeginningcode"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgenerateforwardfrombeginningcode"::: - - The following example illustrates how to use to start generating backward from the end of an item list. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgenerateforwardfrombeginningcode"::: + + The following example illustrates how to use to start generating backward from the end of an item list. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/GeneratorPosition/Overview/Window1.xaml.cs" id="Snippetgeneratebackwardfromendcode"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgeneratebackwardfromendcode"::: - - The following example illustrates how to use to start generating forward from the middle of an item list. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgeneratebackwardfromendcode"::: + + The following example illustrates how to use to start generating forward from the middle of an item list. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/GeneratorPosition/Overview/Window1.xaml.cs" id="Snippetgenerateforwardfrommiddlecode"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgenerateforwardfrommiddlecode"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/GeneratorPosition/Overview/window1.xaml.vb" id="Snippetgenerateforwardfrommiddlecode"::: + ]]> @@ -190,11 +190,11 @@ Gets or sets the index that is relative to the generated (realized) items. An index that is relative to the generated (realized) items. - @@ -236,11 +236,11 @@ Gets or sets the offset that is relative to the ungenerated (unrealized) items near the indexed item. An offset that is relative to the ungenerated (unrealized) items near the indexed item. - @@ -317,7 +317,7 @@ if the values are not equal; otherwise, . - ]]> + ]]> diff --git a/xml/System.Windows.Controls.Primitives/GridViewRowPresenterBase.xml b/xml/System.Windows.Controls.Primitives/GridViewRowPresenterBase.xml index 967754c3a9c..23c7eca6323 100644 --- a/xml/System.Windows.Controls.Primitives/GridViewRowPresenterBase.xml +++ b/xml/System.Windows.Controls.Primitives/GridViewRowPresenterBase.xml @@ -116,7 +116,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -151,7 +151,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls.Primitives/IItemContainerGenerator.xml b/xml/System.Windows.Controls.Primitives/IItemContainerGenerator.xml index 369c0cc2aa7..7364bdca8bd 100644 --- a/xml/System.Windows.Controls.Primitives/IItemContainerGenerator.xml +++ b/xml/System.Windows.Controls.Primitives/IItemContainerGenerator.xml @@ -73,7 +73,7 @@ must be called within the scope of the reference that is returned by a previous call to the method. + must be called within the scope of the reference that is returned by a previous call to the method. ]]> @@ -113,7 +113,7 @@ returns a new , otherwise, the existing is returned. + When the next item to be displayed has not already been generated (realized), returns a new , otherwise, the existing is returned. ]]> @@ -255,7 +255,7 @@ ## Remarks Preparing the specified element includes applying the container style, forwarding information from the host control, such as the value of the property, and other small adjustments. - must be called after the element has been added to the visual tree, so that resource references and inherited properties work correctly. + must be called after the element has been added to the visual tree, so that resource references and inherited properties work correctly. ]]> @@ -369,9 +369,9 @@ must be called before is called. + must be called before is called. - sets to ; when the is disposed, the status changes to or , as appropriate. + sets to ; when the is disposed, the status changes to or , as appropriate. ]]> @@ -415,7 +415,7 @@ . + See . ]]> diff --git a/xml/System.Windows.Controls.Primitives/IScrollInfo.xml b/xml/System.Windows.Controls.Primitives/IScrollInfo.xml index f8dcc85171e..1f67bcd8af5 100644 --- a/xml/System.Windows.Controls.Primitives/IScrollInfo.xml +++ b/xml/System.Windows.Controls.Primitives/IScrollInfo.xml @@ -204,7 +204,7 @@ minus the . + Valid values are between zero and the minus the . ]]> @@ -269,7 +269,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet6"::: @@ -308,7 +308,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet5"::: @@ -419,7 +419,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet11"::: @@ -458,7 +458,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet13"::: @@ -497,7 +497,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet14"::: @@ -536,7 +536,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet12"::: @@ -575,7 +575,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet8"::: @@ -614,7 +614,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet10"::: @@ -653,7 +653,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet9"::: @@ -692,7 +692,7 @@ method in procedural code. + The following example shows how to use the method in procedural code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/IScrollInfo/CanHorizontallyScroll/Window1.xaml.vb" id="Snippet7"::: @@ -731,7 +731,7 @@ must call on this object when properties change. + Classes that implement must call on this object when properties change. Logical scrolling enables scrolling to the next element in the logical tree. Physical scrolling, in contrast, scrolls content by a defined measurable increment in a specified direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set the value of its property to `false`. diff --git a/xml/System.Windows.Controls.Primitives/LayoutInformation.xml b/xml/System.Windows.Controls.Primitives/LayoutInformation.xml index 87be9a36a81..5fc52e9d10b 100644 --- a/xml/System.Windows.Controls.Primitives/LayoutInformation.xml +++ b/xml/System.Windows.Controls.Primitives/LayoutInformation.xml @@ -24,14 +24,14 @@ Defines methods that provide additional information about the layout state of an element. - method to translate the bounding box of a into a . - + method to translate the bounding box of a into a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.vb" id="Snippet2"::: + ]]> @@ -67,11 +67,11 @@ Returns a that represents the visible region of an element. A that represents the visible region of an . - has been applied to the `element`, the returned can be non-rectangular. - + has been applied to the `element`, the returned can be non-rectangular. + ]]> @@ -107,11 +107,11 @@ Returns a that was being processed by the layout engine at the moment of an unhandled exception. A that was being processed by the layout engine at the moment of an unhandled exception. - Occurs when is . @@ -148,14 +148,14 @@ Returns a that represents the layout partition that is reserved for a child element. A that represents the layout slot of the element. - method to translate the bounding box of a into a . - + method to translate the bounding box of a into a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/LayoutInformation/Overview/Window1.xaml.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Windows.Controls.Primitives/MultiSelector.xml b/xml/System.Windows.Controls.Primitives/MultiSelector.xml index 00f9803563b..3e32db35a30 100644 --- a/xml/System.Windows.Controls.Primitives/MultiSelector.xml +++ b/xml/System.Windows.Controls.Primitives/MultiSelector.xml @@ -101,12 +101,12 @@ method sets to `true`. The method sets to `false`. + The method sets to `true`. The method sets to `false`. ## Examples - The following example shows how to use the method in a class derived from . + The following example shows how to use the method in a class derived from . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/MultiSelector/BeginUpdateSelectedItems/MyMultiSelector.xaml.cs" id="Snippet2"::: @@ -190,14 +190,14 @@ to `false` and updates the collection. + This method sets to `false` and updates the collection. - The method sets to `true`. + The method sets to `true`. ## Examples - The following example shows how to use the method in a class derived from . + The following example shows how to use the method in a class derived from . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/MultiSelector/BeginUpdateSelectedItems/MyMultiSelector.xaml.cs" id="Snippet2"::: @@ -238,7 +238,7 @@ method sets to `true`. The method sets to `false`. + The method sets to `true`. The method sets to `false`. @@ -281,7 +281,7 @@ is `true`. + You can use this method only if is `true`. ]]> @@ -333,7 +333,7 @@ is `false`, you cannot add more than one item to the collection. Attempts to do so will cause an exception. + If is `false`, you cannot add more than one item to the collection. Attempts to do so will cause an exception. ]]> @@ -369,7 +369,7 @@ is `true` or `false`. + You can use this method regardless of whether is `true` or `false`. ]]> diff --git a/xml/System.Windows.Controls.Primitives/PlacementMode.xml b/xml/System.Windows.Controls.Primitives/PlacementMode.xml index 18ae72941e8..9ccfb2f465d 100644 --- a/xml/System.Windows.Controls.Primitives/PlacementMode.xml +++ b/xml/System.Windows.Controls.Primitives/PlacementMode.xml @@ -32,7 +32,7 @@ property of a control. The property value, together with the values of the , , and properties, determines where and how a appears on the screen. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + Use the members of this enumeration class to set the value of the property of a control. The property value, together with the values of the , , and properties, determines where and how a appears on the screen. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). diff --git a/xml/System.Windows.Controls.Primitives/Popup.xml b/xml/System.Windows.Controls.Primitives/Popup.xml index 931ac2005e9..c60afa46ae2 100644 --- a/xml/System.Windows.Controls.Primitives/Popup.xml +++ b/xml/System.Windows.Controls.Primitives/Popup.xml @@ -50,19 +50,19 @@ has one content property: . A can have a maximum of one child, which can be any . + **Content Model**: has one content property: . A can have a maximum of one child, which can be any . The following illustration shows a control that has a as its parent. ![Popup illustration](~/add/media/popuppicture.JPG "Popup illustration") - You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). When is displayed on the screen, it does not reposition itself if its parent is repositioned. + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). When is displayed on the screen, it does not reposition itself if its parent is repositioned. A displays its content in its own window on the screen. A control supports animation when the property is set to `true` and the application is running with full trust. An application that is running with full trust has complete access to system resources and is typically installed on the user's system. For more information, see [Security (WPF)](/dotnet/framework/wpf/security-wpf). For bitmap and opacity effects to appear on the content of a , you must set the effects directly on the content. The content of a does not inherit effects that are set on the control or on any other element that is in the parent window. - A is sized to its content by default. When this occurs, applying a or bitmap effects may cause the to be obscured. This occurs because the default size of the content does not provide enough area for the effects to display. If more space is required, you can define a margin around the content to increase the area that is available to the control. + A is sized to its content by default. When this occurs, applying a or bitmap effects may cause the to be obscured. This occurs because the default size of the content does not provide enough area for the effects to display. If more space is required, you can define a margin around the content to increase the area that is available to the control. The property must be set on the when used in a XAML browser application (XBAP). @@ -202,7 +202,7 @@ dependency property. + The identifier for the dependency property. @@ -251,7 +251,7 @@ ## Remarks **Content Model**: The property is the only content property for the control. A can only have one as a child, but that child can contain complex embedded content. For example, the child can be a that contains an , text, and other types of controls. - When content is added to a control, the control becomes the logical parent to the content. Similarly, the content is considered to be the logical child of the . The child content is not added to the visual tree that contains the control. Instead, the child content is rendered in a separate window with its own visual tree when the is set to `true`. + When content is added to a control, the control becomes the logical parent to the content. Similarly, the content is considered to be the logical child of the . The child content is not added to the visual tree that contains the control. Instead, the child content is rendered in a separate window with its own visual tree when the is set to `true`. ## Dependency Property Information @@ -382,29 +382,29 @@ . You can make your control behave like a by adding a to your control and calling the method. + You might want to create a custom control that has the same functionality as an existing control and also exhibits the behavior of a . You can make your control behave like a by adding a to your control and calling the method. This method assigns `child` to the child property and binds the following properties to `child`. -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- You should implement these as dependency properties in your control so it can be used the same way as a . For more information, see [Custom Dependency Properties](/dotnet/framework/wpf/advanced/custom-dependency-properties). - When you call , `child` cannot be a child of a . Also, `PlacementTarget` should be set on your control before you call this method. + When you call , `child` cannot be a child of a . Also, `PlacementTarget` should be set on your control before you call this method. ]]> @@ -462,7 +462,7 @@ ## Examples - The following example shows how to set a delegate. + The following example shows how to set a delegate. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls.Primitives/Popup/CustomPopupPlacementCallback/Window1.xaml.cs" id="Snippetdelegatedefinition"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/Popup/CustomPopupPlacementCallback/window1.xaml.vb" id="Snippetdelegatedefinition"::: @@ -615,7 +615,7 @@ dependency property. + The identifier for the dependency property. @@ -670,7 +670,7 @@ , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -712,7 +712,7 @@ ## Examples - The following example creates a and sets the and properties to 20. The property is set to (which is the default), so the target origin is the bottom left corner of the target area and the popup alignment point is the top left corner of the . + The following example creates a and sets the and properties to 20. The property is set to (which is the default), so the target origin is the bottom left corner of the target area and the popup alignment point is the top left corner of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/CustomPopupPlacementCallback/Window1.xaml" id="Snippet5"::: @@ -801,7 +801,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -914,7 +914,7 @@ that has a width and height of zero (0), because content is not located in the visual tree of its logical parent or . The child content is created in a different window that has its own visual tree. + This method always returns a that has a width and height of zero (0), because content is not located in the visual tree of its logical parent or . The child content is created in a different window that has its own visual tree. ]]> @@ -1225,9 +1225,9 @@ , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). - If the property is `true`, setting to or reverses the position of the ; a with set to aligns its left edge with the right edge of and a with set to aligns its right edge with the left edge of . + If the property is `true`, setting to or reverses the position of the ; a with set to aligns its left edge with the right edge of and a with set to aligns its right edge with the left edge of . ## Dependency Property Information @@ -1320,7 +1320,7 @@ , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1331,7 +1331,7 @@ |Metadata properties set to `true`|None| ## Examples - The following example sets the property of a . The , , , and properties of the are 50, 50, 50, and 100, respectively. The is relative to the bounds of the property. Note that the property does not create a visible element in the application; the example creates a with the same bounds to represent the . + The following example sets the property of a . The , , , and properties of the are 50, 50, 50, and 100, respectively. The is relative to the bounds of the property. Note that the property does not create a visible element in the application; the example creates a with the same bounds to represent the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/CustomPopupPlacementCallback/Window1.xaml" id="Snippet6"::: @@ -1416,7 +1416,7 @@ , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1429,7 +1429,7 @@ ## Examples - The following example creates a that is the child of a , and sets to `ellipse1`, so the popup is relative to the . + The following example creates a that is the child of a , and sets to `ellipse1`, so the popup is relative to the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/CustomPopupPlacementCallback/Window1.xaml" id="Snippet2"::: @@ -1511,7 +1511,7 @@ ## Remarks A can only animate when the property is set to `true`. This requires the application that creates the control to run with full trust. - If the is animated, the will not be animated. + If the is animated, the will not be animated. ## Dependency Property Information @@ -1607,7 +1607,7 @@ property is set to `true`, stays open until it is explicitly closed by setting the property to `false`. When is `false`, the control intercepts all mouse and keyboard events to determine when one of these events occurs outside the control. + When the property is set to `true`, stays open until it is explicitly closed by setting the property to `false`. When is `false`, the control intercepts all mouse and keyboard events to determine when one of these events occurs outside the control. ## Dependency Property Information @@ -1773,7 +1773,7 @@ , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a popup by setting the , , , , and properties. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## XAML Attribute Usage @@ -1815,7 +1815,7 @@ ## Examples - The following example creates a and sets the and properties to 20. The property is set to (which is the default), so the target origin is the bottom left corner of the target area, and the popup alignment point is the top left corner of the . + The following example creates a and sets the and properties to 20. The property is set to (which is the default), so the target origin is the bottom left corner of the target area, and the popup alignment point is the top left corner of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/CustomPopupPlacementCallback/Window1.xaml" id="Snippet5"::: diff --git a/xml/System.Windows.Controls.Primitives/RangeBase.xml b/xml/System.Windows.Controls.Primitives/RangeBase.xml index 27cc1727e31..cc1604788ef 100644 --- a/xml/System.Windows.Controls.Primitives/RangeBase.xml +++ b/xml/System.Windows.Controls.Primitives/RangeBase.xml @@ -38,7 +38,7 @@ control has a that can be set between the and properties. The visually indicates its . In some cases, the user can interactively set the value; in other cases, the value can be set only programmatically. The user can set the of the and , but not the . + A control has a that can be set between the and properties. The visually indicates its . In some cases, the user can interactively set the value; in other cases, the value can be set only programmatically. The user can set the of the and , but not the . ]]> @@ -118,9 +118,9 @@ ## Remarks A control that inherits from determines how this property is used. - When the user clicks the of a , the property increases or decreases by the value of . + When the user clicks the of a , the property increases or decreases by the value of . - When the user invokes the or commands on a , the of the slider changes by the value of . + When the user invokes the or commands on a , the of the slider changes by the value of . The does not use this property. @@ -465,7 +465,7 @@ ## Remarks Subclasses of the can use this method to respond when the value property changes instead of overriding the to provide a new function. For more information, see [Dependency Property Callbacks and Validation](/dotnet/framework/wpf/advanced/dependency-property-callbacks-and-validation). - The method raises the event. When overriding in a derived class, be sure to call the base class' method so that registered delegates receive the event. + The method raises the event. When overriding in a derived class, be sure to call the base class' method so that registered delegates receive the event. ]]> @@ -514,9 +514,9 @@ ## Remarks A control that inherits from determines how this property is used. - When the user clicks the of a , the property increases or decreases by the value of . + When the user clicks the of a , the property increases or decreases by the value of . - When the user invokes the or command on a , the of the slider changes by the value of . + When the user invokes the or command on a , the of the slider changes by the value of . The does not use this property. @@ -591,7 +591,7 @@ , , and properties. + This method returns a string that provides the values of the , , and properties. ]]> @@ -637,9 +637,9 @@ control visually indicates the property in some way. For example, the slider and scrollbar controls have a thumb that is synchronized with the of the control. + The control visually indicates the property in some way. For example, the slider and scrollbar controls have a thumb that is synchronized with the of the control. - If you set to a number that is less than the property, is set to . If you set to a number that is greater than the property, is set to . + If you set to a number that is less than the property, is set to . If you set to a number that is greater than the property, is set to . ## Dependency Property Information @@ -647,7 +647,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -696,7 +696,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier Field|| |Routing Strategy|Bubbling| -|Delegate|, constrained with | +|Delegate|, constrained with | ## XAML Attribute Usage diff --git a/xml/System.Windows.Controls.Primitives/ScrollBar.xml b/xml/System.Windows.Controls.Primitives/ScrollBar.xml index 586249eb7a1..a88847c61e5 100644 --- a/xml/System.Windows.Controls.Primitives/ScrollBar.xml +++ b/xml/System.Windows.Controls.Primitives/ScrollBar.xml @@ -42,7 +42,7 @@ ![Scrollbar illustration](~/add/media/scrollbar-illustration.JPG "Scrollbar illustration") - The control contains a control. The control consists of a control and two controls. You can increase and decrease the property of the control by pressing the controls or by moving the . The default range of values for the property is from 0 to 1. The represents the linear distance of the between the endpoints of the . You can change the default range of values by setting the and properties. The property determines whether the is displayed horizontally or vertically, and you must define this property for the control to appear. + The control contains a control. The control consists of a control and two controls. You can increase and decrease the property of the control by pressing the controls or by moving the . The default range of values for the property is from 0 to 1. The represents the linear distance of the between the endpoints of the . You can change the default range of values by setting the and properties. The property determines whether the is displayed horizontally or vertically, and you must define this property for the control to appear. The in a is oriented so that values increase from top to bottom for a vertical or from left to right for a horizontal . @@ -50,9 +50,9 @@ | property| property| |----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| -||| +||| +||| +||| You can access the control of a control by using the property. @@ -132,9 +132,9 @@ , the calls for the . If returns `true`, the executes that command. If returns `false`, the executes the . + When the user drags the thumb of a , the calls for the . If returns `true`, the executes that command. If returns `false`, the executes the . - The uses this command to enable deferred scrolling. When is `true` and a user drags the of the , the content of the does not change until the user releases the . If deferred scrolling is enabled, the executes the for a horizontal when the user drags the . + The uses this command to enable deferred scrolling. When is `true` and a user drags the of the , the content of the does not change until the user releases the . If deferred scrolling is enabled, the executes the for a horizontal when the user drags the . ]]> @@ -169,9 +169,9 @@ , the calls for the . If returns `true`, the executes that command. If returns `false`, the executes the . + When the user drags the thumb of a , the calls for the . If returns `true`, the executes that command. If returns `false`, the executes the . - The uses this command to enable deferred scrolling. When is `true` and a user drags the of the , the content of the does not change until the user releases the . If deferred scrolling is enabled, the executes the for a vertical when the user drags the . + The uses this command to enable deferred scrolling. When is `true` and a user drags the of the , the content of the does not change until the user releases the . If deferred scrolling is enabled, the executes the for a vertical when the user drags the . ]]> @@ -208,7 +208,7 @@ to `true` only if the value of the is greater than the value and the is enabled. + This implementation sets to `true` only if the value of the is greater than the value and the is enabled. ]]> @@ -243,7 +243,7 @@ of the in the by the value of the property. + This command increases the of the in the by the value of the property. This command occurs when the user presses the DOWN ARROW key. @@ -296,7 +296,7 @@ of the in the by the value of the property. + This command decreases the of the in the by the value of the property. This command occurs when the user presses the left . @@ -349,7 +349,7 @@ of the in the by the value of the property. + This command increases the of the in the by the value of the property. This command occurs when the user presses the right . @@ -402,7 +402,7 @@ of the in the by the value of the property. + This command reduces the of the in the by the value of the property. This command occurs when the user presses the UP ARROW key. @@ -495,7 +495,7 @@ of a provides options for changing the of the . + The of a provides options for changing the of the . ]]> @@ -534,7 +534,7 @@ of a provides options for changing the of the . + The of a provides options for changing the of the . ]]> @@ -603,7 +603,7 @@ of the to the location of the event that occurs while the user presses the SHIFT key. The event is handled by setting in the event data `e` to `true`. + This implementation changes the of the to the location of the event that occurs while the user presses the SHIFT key. The event is handled by setting in the event data `e` to `true`. ]]> @@ -763,7 +763,7 @@ of the in the by the value of the property. + This command increases the of the in the by the value of the property. This command occurs when the user presses the PAGE DOWN key. @@ -816,7 +816,7 @@ of the in the by the value of the property. + This command decreases the of the in the by the value of the property. This command occurs when the user presses the page button that is to the left of the . The following illustration shows the page buttons in a . @@ -871,7 +871,7 @@ of the in the by the value of the property. + This command increases the of the in the by the value of the property. This command occurs when the user presses the page button that is to the right of the . The following illustration shows the page buttons in a . @@ -926,7 +926,7 @@ of the in the by the value of the property. + This command reduces the of the in the by the value of the property. This command occurs when the user presses the PAGE UP key. @@ -985,9 +985,9 @@ of the by dragging the . There is no limit to the number of times this event is raised as the position is dragged. + This event typically occurs multiple times when the user changes the of the by dragging the . There is no limit to the number of times this event is raised as the position is dragged. - This event is not raised when the of the control is changed in code. + This event is not raised when the of the control is changed in code. ## Routed Event Information @@ -1488,11 +1488,11 @@ are the same units that are used to describe the length of the content. Some examples include lines of text or pages of text. + The units that are used for are the same units that are used to describe the length of the content. Some examples include lines of text or pages of text. The value of the property is used to calculate the size of the control that is displayed as the sliding value indicator in a control. The control's size represents the amount of a control's content that is visible. If 25 percent of a control's content is visible, the occupies 25 percent of the track in the . - You can decide which units uses. When you set this property, make sure that the , , , and properties use the same units. + You can decide which units uses. When you set this property, make sure that the , , , and properties use the same units. The following illustration shows how the size reflects the amount of content that is visible. @@ -1509,7 +1509,7 @@ ## Examples - The following example shows how to set the on a control. + The following example shows how to set the on a control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Orientation/Overview/Window1.xaml.cs" id="Snippetviewport"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls.Primitives/ScrollBar/Orientation/window1.xaml.vb" id="Snippetviewport"::: diff --git a/xml/System.Windows.Controls.Primitives/Selector.xml b/xml/System.Windows.Controls.Primitives/Selector.xml index cfaee5967be..cb0ed6613f8 100644 --- a/xml/System.Windows.Controls.Primitives/Selector.xml +++ b/xml/System.Windows.Controls.Primitives/Selector.xml @@ -176,7 +176,7 @@ clears the attached property when the item container is removed from the visual tree. This is done so item containers behave correctly when the uses container recycling. For more information, see and "Container Recycling" in [Optimizing Performance: Controls](/dotnet/framework/wpf/advanced/optimizing-performance-controls). + clears the attached property when the item container is removed from the visual tree. This is done so item containers behave correctly when the uses container recycling. For more information, see and "Container Recycling" in [Optimizing Performance: Controls](/dotnet/framework/wpf/advanced/optimizing-performance-controls). ]]> @@ -279,9 +279,9 @@ attached property to select an item in the when you do not explicitly create the item container. An item container is a class that represents an item in the . , , and are item containers for the controls that inherit from , and each defines an **IsSelected** property. + Use the attached property to select an item in the when you do not explicitly create the item container. An item container is a class that represents an item in the . , , and are item containers for the controls that inherit from , and each defines an **IsSelected** property. - If you do not explicitly create an item container, Windows Presentation Foundation (WPF) implicitly creates one and sets the **IsSelected** property on the item container to the value of . This is the only time is read. is not updated if the selection on the item changes. + If you do not explicitly create an item container, Windows Presentation Foundation (WPF) implicitly creates one and sets the **IsSelected** property on the item container to the value of . This is the only time is read. is not updated if the selection on the item changes. If you explicitly create an item container, you should use the **IsSelected** property on that class. @@ -291,12 +291,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|, registered as Attached| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The follow example creates a that contains two controls. The example does not explicitly create a for either , so it sets directly on each . To illustrate that is not updated, the example binds the property of the first checkbox to . When the user unselects the item in the , the remains checked. Likewise, checking or unchecking the does not affect whether the is selected in the . The example binds of the second to . In this case, unselecting the item in the causes the checkbox to be unchecked, and unchecking the checkbox also unselects the item. + The follow example creates a that contains two controls. The example does not explicitly create a for either , so it sets directly on each . To illustrate that is not updated, the example binds the property of the first checkbox to . When the user unselects the item in the , the remains checked. Likewise, checking or unchecking the does not affect whether the is selected in the . The example binds of the second to . In this case, unselecting the item in the causes the checkbox to be unchecked, and unchecking the checkbox also unselects the item. ```xaml @@ -383,7 +383,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -470,7 +470,7 @@ property to `true` to ensure that the item selected always corresponds to the property in the . For example, suppose that there are two controls with their property set to the same source. Set to `true` on both list boxes to ensure that the selected item in each is the same. + You can set the property to `true` to ensure that the item selected always corresponds to the property in the . For example, suppose that there are two controls with their property set to the same source. Set to `true` on both list boxes to ensure that the selected item in each is the same. ## XAML Attribute Usage @@ -491,7 +491,7 @@ ## Examples - The following example binds two controls to the same . Because is set to `true` on each , the selected item is always the same for both controls + The following example binds two controls to the same . Because is set to `true` on each , the selected item is always the same for both controls :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet2"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet4"::: @@ -921,11 +921,11 @@ supports selecting a single item, the property returns the index of the selected item. If a supports multiple selections, returns the index of the item that the user selected first. + If a supports selecting a single item, the property returns the index of the selected item. If a supports multiple selections, returns the index of the item that the user selected first. - Setting in a that supports multiple selections clears existing selected items and sets the selection to the item specified by the index. returns -1 if selection is empty. + Setting in a that supports multiple selections clears existing selected items and sets the selection to the item specified by the index. returns -1 if selection is empty. - If you set to a value less that -1, an is thrown. If you set to a value equal or greater than the number of child elements, the value is ignored. + If you set to a value less that -1, an is thrown. If you set to a value equal or greater than the number of child elements, the value is ignored. ## Dependency Property Information @@ -933,7 +933,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -1023,9 +1023,9 @@ supports selecting a single item, the property returns the selected item. If a supports multiple selections, returns the item that the user selected first. + If a supports selecting a single item, the property returns the selected item. If a supports multiple selections, returns the item that the user selected first. - Setting in a that supports multiple selections clears existing selected items and sets the selection to the item specified. + Setting in a that supports multiple selections clears existing selected items and sets the selection to the item specified. ## Dependency Property Information @@ -1033,12 +1033,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example gets the from a . + The following example gets the from a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ListBox/Overview/Pane1.xaml.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ListBox/Overview/Pane1.xaml.vb" id="Snippet2"::: @@ -1123,7 +1123,7 @@ property specifies the path to the property that is used to determine the value of the property. Setting to a value X attempts to select an item whose value evaluates to X; if no such item can be found, the selection is cleared. + The property specifies the path to the property that is used to determine the value of the property. Setting to a value X attempts to select an item whose value evaluates to X; if no such item can be found, the selection is cleared. ## Dependency Property Information @@ -1131,12 +1131,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example binds a to a collection of `Employee` objects. The example sets to `@EmployeeNumber` and to `12345`. This selects the `Employee` that has `12345` as the value of `EmployeeNumber`. This example also binds a to the of the . When the user changes the selection in the , the is updated to show the employee number of the currently selected employee. + The following example binds a to a collection of `Employee` objects. The example sets to `@EmployeeNumber` and to `12345`. This selects the `Employee` that has `12345` as the value of `EmployeeNumber`. This example also binds a to the of the . When the user changes the selection in the , the is updated to show the employee number of the currently selected employee. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet2"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet3"::: @@ -1203,7 +1203,7 @@ ## Examples - The following example binds a to a collection of `Employee` objects. The example sets to `@EmployeeNumber` and to `12345`. This selects the `Employee` that has `12345` as the value of `EmployeeNumber`. This example also binds a to the of the . When the user changes the selection in the , the is updated to show the employee number of the currently selected employee. + The following example binds a to a collection of `Employee` objects. The example sets to `@EmployeeNumber` and to `12345`. This selects the `Employee` that has `12345` as the value of `EmployeeNumber`. This example also binds a to the of the . When the user changes the selection in the , the is updated to show the employee number of the currently selected employee. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet2"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/Selector/IsSynchronizedWithCurrentItem/Window1.xaml" id="Snippet3"::: diff --git a/xml/System.Windows.Controls.Primitives/TextBoxBase.xml b/xml/System.Windows.Controls.Primitives/TextBoxBase.xml index d3e97f67495..b12f95a5643 100644 --- a/xml/System.Windows.Controls.Primitives/TextBoxBase.xml +++ b/xml/System.Windows.Controls.Primitives/TextBoxBase.xml @@ -236,12 +236,12 @@ method enables the user to append text to the contents of a text control without using text concatenation, which, can yield better performance when many concatenations are required. + The method enables the user to append text to the contents of a text control without using text concatenation, which, can yield better performance when many concatenations are required. ## Examples - The following example demonstrates how to use the method. + The following example demonstrates how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase11"::: @@ -283,9 +283,9 @@ is enabled, every time that part of a word is selected by the user dragging over part of a word using the mouse, the selection is automatically expanded to include the whole word. The user can override automatic selection of a whole word by momentarily reversing the direction in which the mouse pointer is being dragged as the selection is made. This action undoes the automatic selection of the whole word, and enables the user to precisely select part or all of the word. + When is enabled, every time that part of a word is selected by the user dragging over part of a word using the mouse, the selection is automatically expanded to include the whole word. The user can override automatic selection of a whole word by momentarily reversing the direction in which the mouse pointer is being dragged as the selection is made. This action undoes the automatic selection of the whole word, and enables the user to precisely select part or all of the word. - When is disabled, a selection is not automatically expanded to include whole words; in this case, precise selections are always determined manually. + When is disabled, a selection is not automatically expanded to include whole words; in this case, precise selections are always determined manually. > [!NOTE] > Auto selection does not affect the first word that the user drags across. It is only after this first word boundary is crossed that auto selection takes effect. @@ -362,14 +362,14 @@ ## Remarks > [!NOTE] - > When you call , you must also call to complete the change block otherwise an exception will be thrown. + > When you call , you must also call to complete the change block otherwise an exception will be thrown. - A change block logically groups multiple changes into a single undo unit and prevents text content or selection change events from being raised until after the change block. This way you can make multiple edits to the text element without the danger of the text element being changed at the same time by another listener. A change block is created by calling the method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. + A change block logically groups multiple changes into a single undo unit and prevents text content or selection change events from being raised until after the change block. This way you can make multiple edits to the text element without the danger of the text element being changed at the same time by another listener. A change block is created by calling the method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. ## Examples - The following example shows how to use the and methods to create a change block. + The following example shows how to use the and methods to create a change block. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/BeginChangeEndChangeExample.cs" id="Snippetbeginchangeendchangecodeexampleinline1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/CharacterCasing/Overview/beginchangeendchangeexample.vb" id="Snippetbeginchangeendchangecodeexampleinline1"::: @@ -500,7 +500,7 @@ and adds the text, "This is some text." The example sets the and properties of a to blue. + The following example creates a and adds the text, "This is some text." The example sets the and properties of a to blue. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/CaretBrush/window1.xaml" id="Snippettextbox"::: @@ -576,12 +576,12 @@ TextBox with CaretBrush set to blue . Note that the selected text is not removed from the text editing control in the process. A similar method, , moves the current selection to the and removes the selected text from the text editing control in the process. + A copy operation copies the selected text to the . Note that the selected text is not removed from the text editing control in the process. A similar method, , moves the current selection to the and removes the selected text from the text editing control in the process. ## Examples - The following example demonstrates how to use the method to copy the text that is selected in a control. + The following example demonstrates how to use the method to copy the text that is selected in a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase4"::: @@ -627,12 +627,12 @@ TextBox with CaretBrush set to blue . Note that the selected text is removed (cut) from the text editing control in the process. A similar method, , copies the current selection to the Clipboard, but does not remove the selected text from the text editing control. + A cut operation removes the current selection from the text editing control and copies it to the . Note that the selected text is removed (cut) from the text editing control in the process. A similar method, , copies the current selection to the Clipboard, but does not remove the selected text from the text editing control. ## Examples - The following example demonstrates how to use the method to delete the text that is selected in a control. + The following example demonstrates how to use the method to delete the text that is selected in a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase5"::: @@ -673,7 +673,7 @@ TextBox with CaretBrush set to blue method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. + A change block logically groups multiple changes into a single undo unit. A change block is created by calling the method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. ]]> @@ -712,14 +712,14 @@ TextBox with CaretBrush set to blue ## Remarks > [!NOTE] - > When you call , you must also call to complete the change block otherwise an exception will be thrown. + > When you call , you must also call to complete the change block otherwise an exception will be thrown. - A change block logically groups multiple changes into a single undo unit and prevents text content or selection change events from being raised until after the change block. This way you can make multiple edits to the text element without the danger of the text element being changed at the same time by another process. A change block is created by calling the method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. + A change block logically groups multiple changes into a single undo unit and prevents text content or selection change events from being raised until after the change block. This way you can make multiple edits to the text element without the danger of the text element being changed at the same time by another process. A change block is created by calling the method. Calling the method causes all subsequent changes to be included in the specified change block until a corresponding call to the method is made. ## Examples - The following example shows how to use the and methods to create a change block. + The following example shows how to use the and methods to create a change block. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/BeginChangeEndChangeExample.cs" id="Snippetbeginchangeendchangecodeexampleinline1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/CharacterCasing/Overview/beginchangeendchangeexample.vb" id="Snippetbeginchangeendchangecodeexampleinline1"::: @@ -919,7 +919,7 @@ TextBox with CaretBrush set to blue | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1071,7 +1071,7 @@ TextBox with CaretBrush set to blue | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1107,7 +1107,7 @@ TextBox with CaretBrush set to blue is `true`, a user can still select and copy text. If the property is also set to `true`, a caret will appear in the text box when the text box has keyboard focus. When is `false`, the property has no effect. + When is `true`, a user can still select and copy text. If the property is also set to `true`, a caret will appear in the text box when the text box has keyboard focus. When is `false`, the property has no effect. ]]> @@ -1356,7 +1356,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase13"::: @@ -1398,7 +1398,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase14"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase14"::: @@ -1440,7 +1440,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase15"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase15"::: @@ -1482,7 +1482,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase16"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase16"::: @@ -1565,7 +1565,7 @@ TextBox with CaretBrush set to blue . + Overrides . ]]> @@ -2085,7 +2085,7 @@ TextBox with CaretBrush set to blue ## Remarks The event occurs when the mouse wheel is rolled. - Overrides . + Overrides . ]]> @@ -2270,7 +2270,7 @@ TextBox with CaretBrush set to blue . + Overrides . ]]> @@ -2378,7 +2378,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase17"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase17"::: @@ -2420,7 +2420,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase18"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase18"::: @@ -2462,7 +2462,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase19"::: @@ -2504,7 +2504,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase20"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase20"::: @@ -2546,7 +2546,7 @@ TextBox with CaretBrush set to blue method to paste selected content into a control. + The following example demonstrates how to use the method to paste selected content into a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase6"::: @@ -2589,7 +2589,7 @@ TextBox with CaretBrush set to blue method. + The following example demonstrates how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase9"::: @@ -2633,7 +2633,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase22"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase22"::: @@ -2673,7 +2673,7 @@ TextBox with CaretBrush set to blue method to scroll the contents of a control. + The following example demonstrates how to use the method to scroll the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase21"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase21"::: @@ -2779,7 +2779,7 @@ TextBox with CaretBrush set to blue method to select all the contents of a control. + The following example demonstrates how to use the method to select all the contents of a control. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase7"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase7"::: @@ -2817,7 +2817,7 @@ TextBox with CaretBrush set to blue and properties. The property specifies the opacity of the . + You can specify the brush that highlights selected text by setting the and properties. The property specifies the opacity of the . @@ -2971,7 +2971,7 @@ Selected text in a TextBox with SelectionBrush set to red is set to 0, the is transparent and is not visible. If is set to 1.0 or greater, the is opaque and the selected text is not visible. + If is set to 0, the is transparent and is not visible. If is set to 1.0 or greater, the is opaque and the selected text is not visible. @@ -3228,7 +3228,7 @@ If this property is `null`, selected text is not rendered. method. + The following example demonstrates how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/TextWrapping/Overview/Window1.xaml.cs" id="Snippettextboxbase8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/TextWrapping/Overview/Window1.xaml.vb" id="Snippettextboxbase8"::: @@ -3272,9 +3272,9 @@ If this property is `null`, selected text is not rendered. clears the undo queue. When is set to -1, the undo queue is limited only by the memory that is available. When is set to 0, undo is disabled on the . + Setting clears the undo queue. When is set to -1, the undo queue is limited only by the memory that is available. When is set to 0, undo is disabled on the . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -3412,7 +3412,7 @@ If this property is `null`, selected text is not rendered. | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Primitives/Thumb.xml b/xml/System.Windows.Controls.Primitives/Thumb.xml index 10d4ddcdfa3..ae49c4ee686 100644 --- a/xml/System.Windows.Controls.Primitives/Thumb.xml +++ b/xml/System.Windows.Controls.Primitives/Thumb.xml @@ -46,9 +46,9 @@ A control can receive mouse capture, but cannot receive keyboard focus. Therefore, the property that corresponds to keyboard focus is set to `false`. This value overrides the parent class that sets this property to `true`. - To provide drag capability, class handling is provided for the , and events. For more information, see the , and methods. + To provide drag capability, class handling is provided for the , and events. For more information, see the , and methods. - When a is part of a control that scrolls content in a viewable area, or viewport, the size of the reflects the size of the viewport. For more information, see the class. The following illustration shows a control that is part of a control. + When a is part of a control that scrolls content in a viewable area, or viewport, the size of the reflects the size of the viewport. For more information, see the class. The following illustration shows a control that is part of a control. ![Scrollbar illustration](~/add/media/scrollbar-illustration.JPG "Scrollbar illustration") @@ -169,7 +169,7 @@ event occurs when the left mouse button is released or when the method is called. + This event occurs when the left mouse button is released or when the method is called. The control receives mouse capture when the user presses the left mouse button while pausing the mouse pointer over the control. @@ -266,7 +266,7 @@ control receives focus and mouse capture when the user presses the left mouse button while pausing the mouse pointer over the control. The control loses mouse capture when the user releases the left mouse button, or when the method is called. + The control receives focus and mouse capture when the user presses the left mouse button while pausing the mouse pointer over the control. The control loses mouse capture when the user releases the left mouse button, or when the method is called. A new event occurs each time the mouse position moves on the screen. Therefore, this event can be raised multiple times without a limit when a control has mouse capture. @@ -463,9 +463,9 @@ property changes its value, the method is called. + When the property changes its value, the method is called. - Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Dependency Property Information @@ -603,7 +603,7 @@ event by setting to `true`. Also, this method gives the logical focus and mouse capture, and sets the property to `true`. This implementation also raises the event. + This implementation handles the event by setting to `true`. Also, this method gives the logical focus and mouse capture, and sets the property to `true`. This implementation also raises the event. ]]> @@ -642,7 +642,7 @@ event by setting to `true`. Also, this method removes mouse capture from the , and sets the property to `false`. This implementation also raises the event. + This implementation handles the event by setting to `true`. Also, this method removes mouse capture from the , and sets the property to `false`. This implementation also raises the event. ]]> @@ -681,7 +681,7 @@ has logical focus and mouse capture, this implementation raises the event when the mouse moves. In this scenario, the event is handled by setting to `true`. + If the has logical focus and mouse capture, this implementation raises the event when the mouse moves. In this scenario, the event is handled by setting to `true`. ]]> diff --git a/xml/System.Windows.Controls.Primitives/TickBar.xml b/xml/System.Windows.Controls.Primitives/TickBar.xml index cc1c3e073d7..2ccfc34ca54 100644 --- a/xml/System.Windows.Controls.Primitives/TickBar.xml +++ b/xml/System.Windows.Controls.Primitives/TickBar.xml @@ -50,14 +50,14 @@ | property| property| |------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| -||| -||| -||| -||| -||| -||| +||| +||| +||| +||| +||| +||| +||| +||| ]]> @@ -137,7 +137,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -172,7 +172,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -226,7 +226,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -261,7 +261,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -308,7 +308,7 @@ and properties define a selection range. These properties must be set for the selection range to appear when is set to `true`. + The and properties define a selection range. These properties must be set for the selection range to appear when is set to `true`. The following illustration shows a control that contains a that has a selection range defined. @@ -320,7 +320,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -396,7 +396,7 @@ and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. + Primary ticks are displayed for the and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. ## Dependency Property Information @@ -404,7 +404,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -479,7 +479,7 @@ and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. + Primary ticks are displayed for the and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. ## Dependency Property Information @@ -487,7 +487,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -557,9 +557,9 @@ ## Remarks The values of the property and the property determine where tick marks are drawn in a . - Primary ticks are displayed for the and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. + Primary ticks are displayed for the and values, and secondary ticks are displayed for other values. For a horizontal , the height of the primary ticks is equal to the of the . For a vertical , the width of the primary ticks is equal to the of the . The size of the secondary ticks is 75 percent of the size of the primary ticks. - This method also draws ticks at the beginning and the end of a selection range if the property is `true` and if the and properties are valid. + This method also draws ticks at the beginning and the end of a selection range if the property is `true` and if the and properties are valid. ]]> @@ -605,7 +605,7 @@ value is used to make sure that the visible parts of the , such as the end point indicators of a selection range, are displayed correctly. + The value is used to make sure that the visible parts of the , such as the end point indicators of a selection range, are displayed correctly. ## Dependency Property Information @@ -613,7 +613,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -695,7 +695,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -769,7 +769,7 @@ property must be set to `true` for the and properties to be used. + The property must be set to `true` for the and properties to be used. ## Dependency Property Information @@ -777,7 +777,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -853,7 +853,7 @@ property must be set to `true` for the and properties to be used. + The property must be set to `true` for the and properties to be used. ## Dependency Property Information @@ -861,7 +861,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -945,7 +945,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1020,7 +1020,7 @@ property and that are outside the range that is defined by the and property values do not appear. + Tick marks that are defined by the property and that are outside the range that is defined by the and property values do not appear. When the property is set, the property is not used. @@ -1030,7 +1030,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Primitives/ToggleButton.xml b/xml/System.Windows.Controls.Primitives/ToggleButton.xml index 283d8a198b5..b861093dd9a 100644 --- a/xml/System.Windows.Controls.Primitives/ToggleButton.xml +++ b/xml/System.Windows.Controls.Primitives/ToggleButton.xml @@ -128,7 +128,7 @@ ## Examples - The following example changes subscribes to the and events to change the of the , `textBlock1`. + The following example changes subscribes to the and events to change the of the , `textBlock1`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CheckBox/Overview/Window1.xaml" id="Snippet2"::: @@ -294,13 +294,13 @@ ## CheckBox When the property is set to true, a user can click a to pick three possible states. The following table describes the three states of a . -|State of the |Value of | +|State of the |Value of | |------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |Checked|`true`| |Unchecked|`false`| |Indeterminate|`null`| - If is false, you can still programmatically set this property to `null` to put the in an indeterminate state, but the user cannot set the to the indeterminate state through the user interface (UI). + If is false, you can still programmatically set this property to `null` to put the in an indeterminate state, but the user cannot set the to the indeterminate state through the user interface (UI). ## RadioButton If you set this property to `null` on a , the is unchecked. @@ -319,7 +319,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -401,7 +401,7 @@ property can be set to `null` as a third state when is `true`. + The property can be set to `null` as a third state when is `true`. ## Dependency Property Information @@ -665,7 +665,7 @@ method returns a string that contains the and the value of the property. + The method returns a string that contains the and the value of the property. ]]> @@ -719,7 +719,7 @@ ## Examples - The following example changes subscribes to the and events to change the of the , `textBlock1`. + The following example changes subscribes to the and events to change the of the , `textBlock1`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CheckBox/Overview/Window1.xaml" id="Snippet2"::: diff --git a/xml/System.Windows.Controls.Primitives/ToolBarOverflowPanel.xml b/xml/System.Windows.Controls.Primitives/ToolBarOverflowPanel.xml index 7d0e431fba2..d2e53fee78e 100644 --- a/xml/System.Windows.Controls.Primitives/ToolBarOverflowPanel.xml +++ b/xml/System.Windows.Controls.Primitives/ToolBarOverflowPanel.xml @@ -202,7 +202,7 @@ to 100, the width of the overflow is 100, and all the items that can fit into an area of that size are in the main . If there is only one item, and it requires a size of 120, the toolbar width expands automatically from 100 to 120. + If you set to 100, the width of the overflow is 100, and all the items that can fit into an area of that size are in the main . If there is only one item, and it requires a size of 120, the toolbar width expands automatically from 100 to 120. ## Dependency Property Information @@ -210,7 +210,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -255,7 +255,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls.Primitives/Track.xml b/xml/System.Windows.Controls.Primitives/Track.xml index aaaef55051d..6e739c6ff80 100644 --- a/xml/System.Windows.Controls.Primitives/Track.xml +++ b/xml/System.Windows.Controls.Primitives/Track.xml @@ -46,39 +46,39 @@ | property| property| |----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| -||| +||| +||| +||| The following table shows the properties and the corresponding properties to which they bind when a is part of a control and the properties are not explicitly set. | property| property| |----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| +||| +||| The following table shows the properties and the corresponding properties to which they bind when a is part of a control and the properties are not explicitly set. | property| property| |----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| +||| +||| - Additionally, the properties for the controls for a control bind with the properties for the controls of the control. + Additionally, the properties for the controls for a control bind with the properties for the controls of the control. - When a is used to scroll content, the size of the control is proportional to the percentage of the content that appears in the viewable area or viewport. The following illustration shows an example of a control that implements a control. + When a is used to scroll content, the size of the control is proportional to the percentage of the content that appears in the viewable area or viewport. The following illustration shows an example of a control that implements a control. **A ScrollBar that has a Track control** ![ScrollBar illustration](~/add/media/scrollbargeneric.png "ScrollBar illustration") - The following calculation is used to compute the size of the . + The following calculation is used to compute the size of the . thumbSize = (viewportSize/(maximum-minimum+viewportSize))×trackLength - The viewportSize parameter is the value of the property. The maximum and minimum parameters correspond to the and property values. The value of the expression maximum-minimum+viewportSize is the size of the scrollable content. Note that the value of the property represents the of the when the content is scrolled to the bottom. This value is not the same as the length or extent of the content. For a more detailed explanation, see . + The viewportSize parameter is the value of the property. The maximum and minimum parameters correspond to the and property values. The value of the expression maximum-minimum+viewportSize is the size of the scrollable content. Note that the value of the property represents the of the when the content is scrolled to the bottom. This value is not the same as the length or extent of the content. For a more detailed explanation, see . - The of a in a increases from top to bottom or from left to right depending on the orientation of the . Similarly, the of a in a increases from bottom to top or from left to right depending on the orientation of the . To change the direction of increasing value, set the property of the to `true`. + The of a in a increases from top to bottom or from left to right depending on the orientation of the . Similarly, the of a in a increases from bottom to top or from left to right depending on the orientation of the . To change the direction of increasing value, set the property of the to `true`. ## Examples The following example shows how to define a control in a . @@ -187,12 +187,12 @@ control is in a control, the properties of the controls of the bind to the property of the control. + When a control is in a control, the properties of the controls of the bind to the property of the control. ## Examples - The following example shows how the and styles are defined inside the control template when the property is . For the complete sample, see the [ScrollBar Styles and Templates](/dotnet/framework/wpf/controls/scrollbar-styles-and-templates). + The following example shows how the and styles are defined inside the control template when the property is . For the complete sample, see the [ScrollBar Styles and Templates](/dotnet/framework/wpf/controls/scrollbar-styles-and-templates). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/ScrollBar/LineDownCommand/Window1.xaml" id="Snippetrepeatbuttonstyle"::: @@ -236,7 +236,7 @@ by setting the , , and properties. The child elements are indexed in the order that the properties are set. + You specify the child elements of a by setting the , , and properties. The child elements are indexed in the order that the properties are set. ]]> @@ -279,12 +279,12 @@ control is in a control, the properties of the controls of the bind to the property of the control. + When a control is in a control, the properties of the controls of the bind to the property of the control. ## Examples - The following example shows how the and styles are defined inside the control template when the property is . + The following example shows how the and styles are defined inside the control template when the property is . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/ScrollBar/LineDownCommand/Window1.xaml" id="Snippetrepeatbuttonstyle"::: @@ -325,7 +325,7 @@ is set to `true`, the and the in the exchange places. + When the value of is set to `true`, the and the in the exchange places. values increase from left to right for both horizontal and controls. However, the values for a vertical increase from top to bottom, whereas for a vertical these values increase from bottom to top. When you set the property to `true`, the direction of increasing value reverses. @@ -381,7 +381,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -419,9 +419,9 @@ ## Remarks When a control is in a control and the property is not explicitly set, this property automatically binds with the property. - The value for a control is equivalent to the size of the scrollable content minus the size of the visible content area or viewport. For example, if the size of the content is 100 and the size of the property is 30, the value of the property is 70. This is true because the property of the control corresponds to the position in the scrollable content that appears at the top of the viewport. When the content is scrolled to the very bottom in this example, 30 percent of the content still appears in the viewport. Therefore, the that corresponds to the top of the viewport is 70, and the value is 70. + The value for a control is equivalent to the size of the scrollable content minus the size of the visible content area or viewport. For example, if the size of the content is 100 and the size of the property is 30, the value of the property is 70. This is true because the property of the control corresponds to the position in the scrollable content that appears at the top of the viewport. When the content is scrolled to the very bottom in this example, 30 percent of the content still appears in the viewport. Therefore, the that corresponds to the top of the viewport is 70, and the value is 70. - The following illustration shows how the corresponds to a position in the of a control. + The following illustration shows how the corresponds to a position in the of a control. ![Value corresponds to the position of the content](~/add/media/scrollbarvalueeqmaximum.png "Value corresponds to the position of the content") @@ -431,7 +431,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -475,7 +475,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -552,7 +552,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -594,7 +594,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -630,9 +630,9 @@ as part of a control and you do not explicitly set the property, the property binds to the . + If you implement a as part of a control and you do not explicitly set the property, the property binds to the . - If you implement a as part of a control and you do not explicitly set the property, the property binds to the . + If you implement a as part of a control and you do not explicitly set the property, the property binds to the . ## Dependency Property Information @@ -640,7 +640,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -676,7 +676,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -718,11 +718,11 @@ control corresponds to the of the control. The size of the control in a control reflects the amount of content that is currently visible. The size of the control of the is computed in the following ways: + The placement of the control corresponds to the of the control. The size of the control in a control reflects the amount of content that is currently visible. The size of the control of the is computed in the following ways: -- If the property is not specified, the size of the is a fixed default value. This is how the of a Track functions inside a control. +- If the property is not specified, the size of the is a fixed default value. This is how the of a Track functions inside a control. -- If the property is specified and the size of the content is greater than the , the following formula is used: +- If the property is specified and the size of the content is greater than the , the following formula is used: `ThumbSize = TrackLength * ViewportSize / (Maximum - Minimum + ViewportSize)` @@ -730,7 +730,7 @@ | Parameter | Description | |-|-| - |`ThumbSize`|The size of the control in the same units as the TrackLength.| + |`ThumbSize`|The size of the control in the same units as the TrackLength.| |`TrackLength`|The length of the .| |`ViewportSize`|The size of the scrollable area that is visible in the content units, such as the number of pages of a document.| |`Maximum`|The maximum value of the content in content units, such as page 10 of a 10-page document.| @@ -740,12 +740,12 @@ ![Viewport size, thumb size, and track length.](~/add/media/scrollbarthumbsizemath.png) -- If the size of the content is less than a , the does not appear and the property of is set to `false`. +- If the size of the content is less than a , the does not appear and the property of is set to `false`. - The minimum sizes for a control are determined by two system parameters, and . The minimum size for a control in a vertical is 1/2 * and the minimum size for a control in a horizontal is 1/2 * . + The minimum sizes for a control are determined by two system parameters, and . The minimum size for a control in a vertical is 1/2 * and the minimum size for a control in a horizontal is 1/2 * . ## Examples - The following example shows how the style is defined inside the when the property is . + The following example shows how the style is defined inside the when the property is . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls.Primitives/ScrollBar/LineDownCommand/Window1.xaml" id="Snippetrepeatbuttonstyle"::: @@ -784,7 +784,7 @@ represents a value that is between the and property values. + The represents a value that is between the and property values. When a control is part of a control and the property is not explicitly set, this property automatically binds with the property. @@ -794,7 +794,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -899,7 +899,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -935,13 +935,13 @@ property is used to calculate the size of the control in a when the is not . For more information, see the remarks for the property. + The value of the property is used to calculate the size of the control in a when the is not . For more information, see the remarks for the property. - To explicitly define the size of the , create an object that derives from the class and provide overrides for and . + To explicitly define the size of the , create an object that derives from the class and provide overrides for and . If you implement a as part of a control and you do not explicitly set the property, the property binds to the property. - The value of the property of a control that is implemented in a control is always , because the control does not change size. + The value of the property of a control that is implemented in a control is always , because the control does not change size. ## Dependency Property Information @@ -949,7 +949,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -985,7 +985,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1021,7 +1021,7 @@ by setting the , , and properties. The child elements are indexed in the order that the properties are set. + You specify the child elements of a by setting the , , and properties. The child elements are indexed in the order that the properties are set. ]]> diff --git a/xml/System.Windows.Controls.Primitives/UniformGrid.xml b/xml/System.Windows.Controls.Primitives/UniformGrid.xml index e05e96f2b06..a95a8913cd9 100644 --- a/xml/System.Windows.Controls.Primitives/UniformGrid.xml +++ b/xml/System.Windows.Controls.Primitives/UniformGrid.xml @@ -91,7 +91,7 @@ value of the `arrangeSize` parameter and *arrangeSizeWidth* is the value of the `arrangeSize` parameter. + The `arrangeSize` parameter defines the space in the layout area that is available for the grid. For example, if there are two rows and four columns in a grid, the possible height for each cell is 0.5\**arrangeSizeHeight* and the maximum width is 0.25\**arrangeSizeWidth*. For these calculations, *arrangeSizeHeight* is the value of the `arrangeSize` parameter and *arrangeSizeWidth* is the value of the `arrangeSize` parameter. ]]> @@ -129,7 +129,7 @@ ## Remarks A value of zero (0) for the property specifies that the column count is computed based on the number of rows and the number of visible child elements that are in the . - The value of the must be less than the value of the property for the to work correctly. + The value of the must be less than the value of the property for the to work correctly. ## Dependency Property Information @@ -137,7 +137,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -202,7 +202,7 @@ must be less than the value of the property for the to work correctly. + The value of the must be less than the value of the property for the to work correctly. ## Dependency Property Information @@ -210,7 +210,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -278,9 +278,9 @@ is computed based on the maximum child dimensions. The is the maximum child width multiplied by the number of columns. The is the maximum child height multiplied by the number of rows. This method returns the desired . + The `constraint` parameter defines the maximum amount of space that is available for the grid. This space is divided up equally based on the number of rows and columns in the grid. The size of each child is measured to determine the maximum width of all the child elements of the grid. The maximum values cannot exceed the maximum cell size that is computed from the `constraint`. A desired grid is computed based on the maximum child dimensions. The is the maximum child width multiplied by the number of columns. The is the maximum child height multiplied by the number of rows. This method returns the desired . - For example, if there are two rows and four columns in a grid, the maximum height for each cell is 0.5\**constraintHeight* and the maximum width is 0.25\**constraintWidth*. For these calculations, *constraintHeight* is the value of the `constraint` parameter and *constraintWidth* is the value of the `constraint` parameter. + For example, if there are two rows and four columns in a grid, the maximum height for each cell is 0.5\**constraintHeight* and the maximum width is 0.25\**constraintWidth*. For these calculations, *constraintHeight* is the value of the `constraint` parameter and *constraintWidth* is the value of the `constraint` parameter. ]]> @@ -324,7 +324,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonScrollButtonVisibilityConverter.xml b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonScrollButtonVisibilityConverter.xml index e7c5b0413e6..4a6fceb13eb 100644 --- a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonScrollButtonVisibilityConverter.xml +++ b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonScrollButtonVisibilityConverter.xml @@ -104,7 +104,7 @@ values that represent the scroll bar position are the , , and property values of the or . These properties contain values from the panel's internal . + The three values that represent the scroll bar position are the , , and property values of the or . These properties contain values from the panel's internal . The `parameter` value represents the desired percentage that the ribbon is scrolled to the right before the scroll button is hidden. By default, the left scroll button passes 0 as the parameter, and it is hidden when the ribbon is scrolled 0 percent to the right. The right scroll button passes 100 as the parameter, and it is hidden when the ribbon is scrolled 100 percent to the right. diff --git a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabHeadersPanel.xml b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabHeadersPanel.xml index 9e1b1374112..2aacbf9628d 100644 --- a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabHeadersPanel.xml +++ b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabHeadersPanel.xml @@ -233,7 +233,7 @@ value of the panel's internal . + This property contains the value of the panel's internal . ]]> @@ -271,7 +271,7 @@ value of the panel's internal . + This property contains the value of the panel's internal . ]]> @@ -1136,7 +1136,7 @@ value of the panel's internal . + This property contains the value of the panel's internal . ]]> diff --git a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabsPanel.xml b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabsPanel.xml index 8513ea1dae7..b83c6d7a1f7 100644 --- a/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabsPanel.xml +++ b/xml/System.Windows.Controls.Ribbon.Primitives/RibbonTabsPanel.xml @@ -27,11 +27,11 @@ Represents a panel that supports horizontal scrolling of tabs in a . - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -154,11 +154,11 @@ in all cases. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -192,11 +192,11 @@ This API is not implemented. 0.0 in all cases. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -230,11 +230,11 @@ Gets the horizontal size of the scrolled content in device-independent units (1/96th inch per unit). The horizontal size of the scrolled content in device-independent units (1/96th inch per unit). This property has no default value. - value of the panel's internal . - + value of the panel's internal . + ]]> @@ -268,11 +268,11 @@ Gets the horizontal offset of the scrolled content in device-independent units (1/96th inch per unit). The horizontal offset of the scrolled content in device-independent units (1/96th inch per unit). This property has no default value. - value of the panel's internal . - + value of the panel's internal . + ]]> @@ -306,11 +306,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -406,11 +406,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -513,11 +513,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -551,11 +551,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -589,11 +589,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -627,11 +627,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -665,11 +665,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -703,11 +703,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -741,11 +741,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -779,11 +779,11 @@ This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -885,11 +885,11 @@ This API is not implemented. This API is not implemented. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -923,11 +923,11 @@ This API is not implemented. 0.0 in all cases. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -961,11 +961,11 @@ This API is not implemented. 0.0 in all cases. - provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. - + provides horizontal scrolling by line for controls in a . Scrolling up or down, and scrolling by page is not supported. + ]]> @@ -999,11 +999,11 @@ Gets the horizontal size of the content's visible range in device-independent units (1/96th inch per unit). The horizontal size of the content's visible range in device-independent units (1/96th inch per unit). This property has no default value. - value of the panel's internal . - + value of the panel's internal . + ]]> diff --git a/xml/System.Windows.Controls.Ribbon/Ribbon.xml b/xml/System.Windows.Controls.Ribbon/Ribbon.xml index 87b6057f7ca..2f3e64339e1 100644 --- a/xml/System.Windows.Controls.Ribbon/Ribbon.xml +++ b/xml/System.Windows.Controls.Ribbon/Ribbon.xml @@ -69,7 +69,7 @@ - - - + - - @@ -77,7 +77,7 @@ - , , - - + - - @@ -85,9 +85,9 @@ - - - + - - - + - - @@ -1559,7 +1559,7 @@ xmlns:ribbon="clr-namespace:System.Windows.Controls.Ribbon;assembly=RibbonContro method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -2275,9 +2275,9 @@ xmlns:ribbon="clr-namespace:System.Windows.Controls.Ribbon;assembly=RibbonContro ## Remarks You will typically set the property on the instead of setting the property. - The is shown in the title bar of the if the property of the is `null`. If the property is not `null`, the title is shown instead of the value. + The is shown in the title bar of the if the property of the is `null`. If the property is not `null`, the title is shown instead of the value. - If the is hosted in a instead of a , the is shown next to the Quick Access Toolbar, below the . + If the is hosted in a instead of a , the is shown next to the Quick Access Toolbar, below the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenu.xml b/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenu.xml index 1b062076748..25a4f267deb 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenu.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenu.xml @@ -71,11 +71,11 @@ - - - + - - - - + - - @@ -676,7 +676,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenuItem.xml b/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenuItem.xml index eea82253dd4..721ff811309 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenuItem.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonApplicationMenuItem.xml @@ -35,7 +35,7 @@ ## Remarks You typically use a to invoke a command when the menu item is clicked. For more information about using commands with menu items, see [How to: Add a Command to a MenuItem](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741839(v=vs.90)). - A can have submenus. The submenu of the is made up of the objects within the collection of a . It is common for a to contain other objects to create nested submenus. + A can have submenus. The submenu of the is made up of the objects within the collection of a . It is common for a to contain other objects to create nested submenus. A cannot have submenus and also invoke a command. If the has a submenu, the command associated with the is not invoked. When you need a control that acts as a menu header and invokes a command, use a . @@ -269,7 +269,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonApplicationSplitMenuItem.xml b/xml/System.Windows.Controls.Ribbon/RibbonApplicationSplitMenuItem.xml index 8f3917b2f9e..238a11784f3 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonApplicationSplitMenuItem.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonApplicationSplitMenuItem.xml @@ -35,7 +35,7 @@ ## Remarks You typically use a when you want to invoke a command and also display a submenu of related commands using a single menu item. For more information about using commands with menu items, see [How to: Add a Command to a MenuItem](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741839(v=vs.90)). - The command that is associated with the is invoked when the menu item is clicked. The submenu is displayed when the mouse pointer is moved over the menu item. The submenu of the is made up of the objects within the collection of a . It is common for a to host objects to create submenus. + The command that is associated with the is invoked when the menu item is clicked. The submenu is displayed when the mouse pointer is moved over the menu item. The submenu of the is made up of the objects within the collection of a . It is common for a to host objects to create submenus. The following illustration shows the Application Menu for a ribbon control. The **Save As** and **Print** items are examples of the control. @@ -267,7 +267,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonButton.xml index a9b24aa6284..652d0f6d2ad 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonButton.xml @@ -667,7 +667,7 @@ Ribbon button controls with highlight property on the to control the visibility of the label. + Set the property on the to control the visibility of the label. ## Dependency Property Information @@ -747,7 +747,7 @@ Ribbon button controls property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -987,7 +987,7 @@ Ribbon button controls method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1655,7 +1655,7 @@ Ribbon button controls property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonCheckBox.xml b/xml/System.Windows.Controls.Ribbon/RibbonCheckBox.xml index 976f07b01b6..af5f847ccc4 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonCheckBox.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonCheckBox.xml @@ -722,7 +722,7 @@ Ribbon check box controls that are selected property on the to control the visibility of the label. + Set the property on the to control the visibility of the label. ## Dependency Property Information @@ -799,7 +799,7 @@ Ribbon check box controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -1046,7 +1046,7 @@ Ribbon check box controls that are selected method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1686,7 +1686,7 @@ Ribbon check box controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonComboBox.xml b/xml/System.Windows.Controls.Ribbon/RibbonComboBox.xml index b7f20443951..c904393c329 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonComboBox.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonComboBox.xml @@ -106,7 +106,7 @@ Ribbon combo box control with drop-down open method. + This method undoes the effects of the method. ]]> @@ -319,7 +319,7 @@ Ribbon combo box control with drop-down open method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1233,7 +1233,7 @@ Ribbon combo box control with drop-down open and is `true`, this property represents the text entered in the text box. When is `false`, this property represents the string version of the selected item. + When there is no and is `true`, this property represents the text entered in the text box. When is `false`, this property represents the string version of the selected item. ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonContentPresenter.xml b/xml/System.Windows.Controls.Ribbon/RibbonContentPresenter.xml index 30c6568ba6a..e6edc747611 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonContentPresenter.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonContentPresenter.xml @@ -290,7 +290,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonContextMenu.xml b/xml/System.Windows.Controls.Ribbon/RibbonContextMenu.xml index 3c6852979ca..4914d50b74d 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonContextMenu.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonContextMenu.xml @@ -90,7 +90,7 @@ method. + This method undoes the effects of the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonContextualTabGroupItemsControl.xml b/xml/System.Windows.Controls.Ribbon/RibbonContextualTabGroupItemsControl.xml index 86bd96163c6..acfcf3fb945 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonContextualTabGroupItemsControl.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonContextualTabGroupItemsControl.xml @@ -84,7 +84,7 @@ method. + This method undoes the effects of the method. ]]> @@ -181,7 +181,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonControl.xml b/xml/System.Windows.Controls.Ribbon/RibbonControl.xml index 6db60ad1ba9..84f878202b3 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonControl.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonControl.xml @@ -311,7 +311,7 @@ Ribbon controls that are selected method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonControlGroup.xml b/xml/System.Windows.Controls.Ribbon/RibbonControlGroup.xml index cc8832bb09c..2f887acf268 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonControlGroup.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonControlGroup.xml @@ -84,7 +84,7 @@ method. + This method undoes the effects of the method. ]]> @@ -252,7 +252,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonControlService.xml b/xml/System.Windows.Controls.Ribbon/RibbonControlService.xml index d32020a44a8..91a24cbcafe 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonControlService.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonControlService.xml @@ -404,7 +404,7 @@ contains properties that specify size and visibility information for the image and label associated with a control. If the property is not set for a ribbon control, the property is used instead. The default control size definition is based on the control's property settings. If a is specified, it is the default. If is `null`, and a is specified, the is the default. If both the and are `null`, the image is set to by default. If the property is null or empty, it is hidden by default. + A contains properties that specify size and visibility information for the image and label associated with a control. If the property is not set for a ribbon control, the property is used instead. The default control size definition is based on the control's property settings. If a is specified, it is the default. If is `null`, and a is specified, the is the default. If both the and are `null`, the image is set to by default. If the property is null or empty, it is hidden by default. ## Dependency Property Information @@ -1667,7 +1667,7 @@ property on the to control the visibility of the label. + Set the property on the to control the visibility of the label. ## Dependency Property Information @@ -2224,7 +2224,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonControlSizeDefinition.xml b/xml/System.Windows.Controls.Ribbon/RibbonControlSizeDefinition.xml index 564c4c6d7c4..49f0e15bbcc 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonControlSizeDefinition.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonControlSizeDefinition.xml @@ -116,7 +116,7 @@ control can display a image, a image, or the image can be . If the control does not specify an image of the size that corresponds to the setting, no image is displayed. + A control can display a image, a image, or the image can be . If the control does not specify an image of the size that corresponds to the setting, no image is displayed. ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonFilterMenuButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonFilterMenuButton.xml index e18e13b5bae..b4c45e1093f 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonFilterMenuButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonFilterMenuButton.xml @@ -113,11 +113,11 @@ Builds the visual tree for the when a new template is applied. - method. - + method. + ]]> @@ -151,11 +151,11 @@ The event data. Provides class handling for the attached event. - attached event as handled so that the parent drop-down is not closed. - + attached event as handled so that the parent drop-down is not closed. + ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonGallery.xml b/xml/System.Windows.Controls.Ribbon/RibbonGallery.xml index 3f67fc5d44b..e1c4035e4e3 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonGallery.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonGallery.xml @@ -141,7 +141,7 @@ Ribbon gallery in a combo box or , you can use this property to distinguish between "All" filter items and custom filter items. + If you implement a custom or , you can use this property to distinguish between "All" filter items and custom filter items. ]]> @@ -605,7 +605,7 @@ Ribbon gallery in a combo box method. + This method undoes the effects of the method. ]]> @@ -641,7 +641,7 @@ Ribbon gallery in a combo box property only has an effect when is set to `true`. + The property only has an effect when is set to `true`. ## Dependency Property Information @@ -1739,7 +1739,7 @@ Ribbon gallery in a combo box | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1878,7 +1878,7 @@ Ribbon gallery in a combo box | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1947,7 +1947,7 @@ Ribbon gallery in a combo box | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2009,7 +2009,7 @@ Ribbon gallery in a combo box method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -2668,7 +2668,7 @@ Ribbon gallery in a combo box | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2739,7 +2739,7 @@ Ribbon gallery in a combo box | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonGalleryCategory.xml b/xml/System.Windows.Controls.Ribbon/RibbonGalleryCategory.xml index 5f827a755e6..9109465a55d 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonGalleryCategory.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonGalleryCategory.xml @@ -102,7 +102,7 @@ method. + This method undoes the effects of the method. ]]> @@ -138,7 +138,7 @@ property only has an effect when is set to `true`. + The property only has an effect when is set to `true`. ## Dependency Property Information @@ -349,7 +349,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -418,7 +418,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -487,7 +487,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -549,7 +549,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -616,7 +616,7 @@ event and adds an event listener to listen for currency changes on the for the category. + This method raises the event and adds an event listener to listen for currency changes on the for the category. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonGalleryItem.xml b/xml/System.Windows.Controls.Ribbon/RibbonGalleryItem.xml index a63f6393963..b4b974c9661 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonGalleryItem.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonGalleryItem.xml @@ -365,7 +365,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -833,7 +833,7 @@ and properties to `false` when this control loses keyboard focus. + This method sets the and properties to `false` when this control loses keyboard focus. This implementation marks the event as handled by setting the property of the event data to `true`. @@ -873,7 +873,7 @@ and properties to `false` when the mouse pointer leaves this control. + This method sets the and properties to `false` when the mouse pointer leaves this control. This implementation marks the event as handled by setting the property of the event data to `true`. diff --git a/xml/System.Windows.Controls.Ribbon/RibbonGroup.xml b/xml/System.Windows.Controls.Ribbon/RibbonGroup.xml index 0d76db0e110..944279b8c80 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonGroup.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonGroup.xml @@ -191,7 +191,7 @@ method. + This method undoes the effects of the method. ]]> @@ -267,7 +267,7 @@ ## Examples - The following example shows a collection that specifies three different group sizes. + The following example shows a collection that specifies three different group sizes. ```xaml @@ -938,7 +938,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonGroupSizeDefinition.xml b/xml/System.Windows.Controls.Ribbon/RibbonGroupSizeDefinition.xml index 79535b056b0..01600dd4788 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonGroupSizeDefinition.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonGroupSizeDefinition.xml @@ -32,7 +32,7 @@ collection that specifies three different group sizes. + The following example shows a collection that specifies three different group sizes. ```xaml diff --git a/xml/System.Windows.Controls.Ribbon/RibbonImageSize.xml b/xml/System.Windows.Controls.Ribbon/RibbonImageSize.xml index 59a1bca015f..1ace21e1c38 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonImageSize.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonImageSize.xml @@ -22,13 +22,13 @@ Defines constants that specify how images are shown on controls. - control can display a Large image, a Small image, or the image can be Collapsed. If the control does not specify an image of the size that corresponds to the setting, no image is displayed. - - A Small image is typically 16x16 pixels at 96 dpi. A Large image is typically 32x32 pixels at 96 dpi. - + control can display a Large image, a Small image, or the image can be Collapsed. If the control does not specify an image of the size that corresponds to the setting, no image is displayed. + + A Small image is typically 16x16 pixels at 96 dpi. A Large image is typically 32x32 pixels at 96 dpi. + ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonMenuButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonMenuButton.xml index 57a5843f109..61efd66c972 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonMenuButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonMenuButton.xml @@ -341,7 +341,7 @@ Ribbon menu button control with drop-down open method. + This method undoes the effects of the method. ]]> @@ -1325,7 +1325,7 @@ Ribbon menu button control with drop-down open property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -1572,7 +1572,7 @@ Ribbon menu button control with drop-down open method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -2347,7 +2347,7 @@ Ribbon menu button control with drop-down open property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonMenuItem.xml b/xml/System.Windows.Controls.Ribbon/RibbonMenuItem.xml index 21981d46bf1..b1ab3c949c5 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonMenuItem.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonMenuItem.xml @@ -454,7 +454,7 @@ method. + This method undoes the effects of the method. ]]> @@ -1071,7 +1071,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml b/xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml index d3761499fd5..eb87651081e 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml @@ -68,7 +68,7 @@ - , , - - + - ## Examples The following example shows a simple ribbon that is created by the Visual Studio 2010 template, with help pane and Quick Access Toolbar elements added. @@ -170,7 +170,7 @@ method. + This method undoes the effects of the method. ]]> @@ -569,7 +569,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -662,7 +662,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonRadioButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonRadioButton.xml index 1c9931dd239..f097f81dc98 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonRadioButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonRadioButton.xml @@ -805,7 +805,7 @@ Ribbon radio button controls that are selected property on the to control the visibility of the label. + Set the property on the to control the visibility of the label. ## Dependency Property Information @@ -882,7 +882,7 @@ Ribbon radio button controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -1129,7 +1129,7 @@ Ribbon radio button controls that are selected method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1797,7 +1797,7 @@ Ribbon radio button controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonSplitButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonSplitButton.xml index 0669b25bc68..ee217695422 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonSplitButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonSplitButton.xml @@ -1151,7 +1151,7 @@ Ribbon split button control with drop-down open | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1313,7 +1313,7 @@ Ribbon split button control with drop-down open method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonSplitMenuItem.xml b/xml/System.Windows.Controls.Ribbon/RibbonSplitMenuItem.xml index 6999ea33b1e..e920ddbdfce 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonSplitMenuItem.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonSplitMenuItem.xml @@ -708,7 +708,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonTab.xml b/xml/System.Windows.Controls.Ribbon/RibbonTab.xml index 9a4b08565f2..35a275cd4f7 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonTab.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonTab.xml @@ -118,7 +118,7 @@ method. + This method undoes the effects of the method. ]]> @@ -353,7 +353,7 @@ |Metadata properties set to `true`|None| ## Examples - The following example shows how to specify the . + The following example shows how to specify the . ```xaml | -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonTabHeader.xml b/xml/System.Windows.Controls.Ribbon/RibbonTabHeader.xml index bc696f165a7..45ef807e713 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonTabHeader.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonTabHeader.xml @@ -711,7 +711,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -925,7 +925,7 @@ method, and then ensures that the is completely rendered before the and properties are calculated. + This override calls the base method, and then ensures that the is completely rendered before the and properties are calculated. ]]> diff --git a/xml/System.Windows.Controls.Ribbon/RibbonTextBox.xml b/xml/System.Windows.Controls.Ribbon/RibbonTextBox.xml index e8699cd86e2..0c2fd8c0365 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonTextBox.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonTextBox.xml @@ -896,7 +896,7 @@ Ribbon text box controls property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -1143,7 +1143,7 @@ Ribbon text box controls method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1648,7 +1648,7 @@ Ribbon text box controls property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonToggleButton.xml b/xml/System.Windows.Controls.Ribbon/RibbonToggleButton.xml index 1ec427a0e18..aa012fc7768 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonToggleButton.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonToggleButton.xml @@ -805,7 +805,7 @@ Ribbon toggle button controls that are selected property on the to control the visibility of the label. + Set the property on the to control the visibility of the label. ## Dependency Property Information @@ -882,7 +882,7 @@ Ribbon toggle button controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information @@ -1129,7 +1129,7 @@ Ribbon toggle button controls that are selected method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -1797,7 +1797,7 @@ Ribbon toggle button controls that are selected property on the to control the visibility of the . + Set the property on the to control the visibility of the . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonToolTip.xml b/xml/System.Windows.Controls.Ribbon/RibbonToolTip.xml index 1e2976e0960..1720a7998b5 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonToolTip.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonToolTip.xml @@ -356,7 +356,7 @@ , , or properties has content. + This property returns `true` if any one of the , , or properties has content. ## Dependency Property Information @@ -427,7 +427,7 @@ , , or properties has content. + This property returns `true` if any one of the , , or properties has content. ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonTwoLineText.xml b/xml/System.Windows.Controls.Ribbon/RibbonTwoLineText.xml index 7bd54844768..d56b9369bba 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonTwoLineText.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonTwoLineText.xml @@ -93,7 +93,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -232,7 +232,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -300,7 +300,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -371,7 +371,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -473,7 +473,7 @@ method. + This method is invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the method. ]]> @@ -608,7 +608,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -883,7 +883,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -918,7 +918,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -988,7 +988,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -1058,7 +1058,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information @@ -1155,7 +1155,7 @@ property of the control's internal . For more information, see . + This property gets or sets the value of the property of the control's internal . For more information, see . ## Dependency Property Information diff --git a/xml/System.Windows.Controls.Ribbon/RibbonWindow.xml b/xml/System.Windows.Controls.Ribbon/RibbonWindow.xml index b79913235b0..3c9241c3014 100644 --- a/xml/System.Windows.Controls.Ribbon/RibbonWindow.xml +++ b/xml/System.Windows.Controls.Ribbon/RibbonWindow.xml @@ -86,11 +86,11 @@ Builds the visual tree for the when a new template is applied. - method. - + method. + ]]> diff --git a/xml/System.Windows.Controls/AccessText.xml b/xml/System.Windows.Controls/AccessText.xml index 85c60b94e85..733c16c5d8c 100644 --- a/xml/System.Windows.Controls/AccessText.xml +++ b/xml/System.Windows.Controls/AccessText.xml @@ -37,7 +37,7 @@ . The other underscores appear as normal text. If the underscore that you want converted to the access key is not the first underscore, use two consecutive underscores for any underscores that precede the one that you want to convert. For example, the following code contains an access key and displays as _Hello**W**orld: + If your content has multiple underscore characters, only the first one is converted into an . The other underscores appear as normal text. If the underscore that you want converted to the access key is not the first underscore, use two consecutive underscores for any underscores that precede the one that you want to convert. For example, the following code contains an access key and displays as _Hello**W**orld: ```xaml __Hello_World @@ -45,7 +45,7 @@ Because the underscore that precedes H is a double, the W key registers as the access key. - To use as a content host in a control style, set in the , as this example shows: + To use as a content host in a control style, set in the , as this example shows: ```xaml @@ -54,7 +54,7 @@ ## Examples - You can use the tag to create an ; however, a tag is not necessary. The following example shows how to create an access key with and without the tag. + You can use the tag to create an ; however, a tag is not necessary. The following example shows how to create an access key with and without the tag. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/AccessText/Overview/pane1.xaml" id="Snippet2"::: @@ -125,7 +125,7 @@ ## Remarks Use the property to programmatically determine which character is parsed by . - The registers the character and raises the event when users press the key. + The registers the character and raises the event when users press the key. ]]> @@ -201,7 +201,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -359,7 +359,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -448,7 +448,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## XAML Attribute Usage @@ -556,7 +556,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -629,7 +629,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -708,7 +708,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -787,7 +787,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -906,7 +906,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## XAML Attribute Usage @@ -1006,13 +1006,13 @@ properties control the line box that is reserved for text. allows users to set a suggestion of height. defines how the is enforced. + properties control the line box that is reserved for text. allows users to set a suggestion of height. defines how the is enforced. You can set the property to or . - The value increases the line to the tallest object in the line. It ensures that no item overdraws or is trimmed. -- The value enforces a value on all lines. If the property does not provide sufficient space, the text is either overdrawn or trimmed. Which occurs depends on the value. +- The value enforces a value on all lines. If the property does not provide sufficient space, the text is either overdrawn or trimmed. Which occurs depends on the value. ## Dependency Property Information @@ -1020,7 +1020,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -1262,7 +1262,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples The following example creates an access key that customizes the first letter of the access key, which contains the mnemonic, and then sets the rest of the text by using the property. @@ -1312,7 +1312,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -1404,7 +1404,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1498,7 +1498,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1599,7 +1599,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -1671,7 +1671,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Controls/AdornedElementPlaceholder.xml b/xml/System.Windows.Controls/AdornedElementPlaceholder.xml index 1ea3d1c2a12..12717ab51c4 100644 --- a/xml/System.Windows.Controls/AdornedElementPlaceholder.xml +++ b/xml/System.Windows.Controls/AdornedElementPlaceholder.xml @@ -37,7 +37,7 @@ that serves as a custom validation to provide visual feedback when the user input is not valid. + Use this class only if you are creating a that serves as a custom validation to provide visual feedback when the user input is not valid. For example, you might want a red exclamation point to appear next to a text box when the input is not valid, as in the following illustration. @@ -59,7 +59,7 @@ The element specifies where the control being adorned (the in this case) should be placed. - You can then specify your template as the for your , as in the following example. + You can then specify your template as the for your , as in the following example. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetcustomvalidation"::: diff --git a/xml/System.Windows.Controls/AlternationConverter.xml b/xml/System.Windows.Controls/AlternationConverter.xml index 97f321ff043..670caae6154 100644 --- a/xml/System.Windows.Controls/AlternationConverter.xml +++ b/xml/System.Windows.Controls/AlternationConverter.xml @@ -41,12 +41,12 @@ - Create an and add a blue and a light blue to its property. -- In a for , bind the property to and assign the converter you created to the property. +- In a for , bind the property to and assign the converter you created to the property. ## Examples - The following example creates a and uses two objects to alternate the and of the items. + The following example creates a and uses two objects to alternate the and of the items. :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/AlternationCount/Window1.xaml" id="Snippet4"::: @@ -199,12 +199,12 @@ to bind a property to alternating values, the property contains the objects that are assigned to the property. For example, if you want items in a to have alternating blue and light blue backgrounds, you add a blue and a light blue to . + When you use the to bind a property to alternating values, the property contains the objects that are assigned to the property. For example, if you want items in a to have alternating blue and light blue backgrounds, you add a blue and a light blue to . ## Examples - The following example creates a and uses two objects to alternate the and of the items. + The following example creates a and uses two objects to alternate the and of the items. :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/AlternationCount/Window1.xaml" id="Snippet4"::: diff --git a/xml/System.Windows.Controls/BooleanToVisibilityConverter.xml b/xml/System.Windows.Controls/BooleanToVisibilityConverter.xml index b6de08e6254..0a3b6b1ed01 100644 --- a/xml/System.Windows.Controls/BooleanToVisibilityConverter.xml +++ b/xml/System.Windows.Controls/BooleanToVisibilityConverter.xml @@ -34,11 +34,11 @@ Represents the converter that converts Boolean values to and from enumeration values. - class to convert a Boolean to and from a value. The method returns when `true` is passed in or when `false` is passed in. Note that the value hides the control and does not reserve space for it in a layout. When you call the method and specify a reference to an object, it returns `true` if the object is ; otherwise, it returns `false`. - + class to convert a Boolean to and from a value. The method returns when `true` is passed in or when `false` is passed in. Note that the value hides the control and does not reserve space for it in a layout. When you call the method and specify a reference to an object, it returns `true` if the object is ; otherwise, it returns `false`. + ]]> diff --git a/xml/System.Windows.Controls/Border.xml b/xml/System.Windows.Controls/Border.xml index bf54d54a25c..6eb8e00f618 100644 --- a/xml/System.Windows.Controls/Border.xml +++ b/xml/System.Windows.Controls/Border.xml @@ -158,7 +158,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -239,7 +239,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -320,7 +320,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -394,7 +394,7 @@ also supports non-uniform radii. Radius values that are too large are scaled so that they blend smoothly from corner to corner. + Although the property name suggests that you can use only singular values, also supports non-uniform radii. Radius values that are too large are scaled so that they blend smoothly from corner to corner. ## Dependency Property Information @@ -402,7 +402,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -557,7 +557,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Controls/BorderGapMaskConverter.xml b/xml/System.Windows.Controls/BorderGapMaskConverter.xml index b9687e42cdc..47ec6ea7711 100644 --- a/xml/System.Windows.Controls/BorderGapMaskConverter.xml +++ b/xml/System.Windows.Controls/BorderGapMaskConverter.xml @@ -31,7 +31,7 @@ created by this converter applies an to the of the so that it does not appear in the area defined for the of the . + The created by this converter applies an to the of the so that it does not appear in the area defined for the of the . ]]> @@ -113,7 +113,7 @@ ## Remarks The three numbers that are in the `values` parameter represent the following control parameters: -- The width of the content. +- The width of the content. - The width of the control. diff --git a/xml/System.Windows.Controls/Button.xml b/xml/System.Windows.Controls/Button.xml index 761e26bfab7..b6d5429023c 100644 --- a/xml/System.Windows.Controls/Button.xml +++ b/xml/System.Windows.Controls/Button.xml @@ -30,11 +30,11 @@ ## Remarks The class inherits directly from the class. - **Content Model:** is a . Its content property is . + **Content Model:** is a . Its content property is . Handle the event to respond when the user clicks a . - The method marks the event as handled. To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. + The method marks the event as handled. To respond to the event, attach an event handler to the event, or call with `handledEventsToo` set to `true`. ## Customizing the Button Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [Button Styles and Templates](/dotnet/framework/wpf/controls/button-styles-and-templates). @@ -254,10 +254,10 @@ property is `true` when the property is set to `true` and the control that has focus does not accept ENTER as input. For example, in the **Run** dialog box, the **OK** button is the default button. When focus is on the text box, on the **OK** button is `true` because a user can activate the button by pressing ENTER. + The property is `true` when the property is set to `true` and the control that has focus does not accept ENTER as input. For example, in the **Run** dialog box, the **OK** button is the default button. When focus is on the text box, on the **OK** button is `true` because a user can activate the button by pressing ENTER. > [!NOTE] -> If the default button has focus, is `false`. This is because the method handles ENTER, and it is not necessary for to be set to `true`. +> If the default button has focus, is `false`. This is because the method handles ENTER, and it is not necessary for to be set to `true`. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/Calendar.xml b/xml/System.Windows.Controls/Calendar.xml index 35163af4310..d753485e010 100644 --- a/xml/System.Windows.Controls/Calendar.xml +++ b/xml/System.Windows.Controls/Calendar.xml @@ -47,29 +47,29 @@ |Task|Implementation| |----------|--------------------| |Have the display a month, an entire year, or a decade.|Set the property to Month, Year, or Decade.| -|Specify whether the user can select a date, a range of dates, or multiple ranges of dates.|Use the .| +|Specify whether the user can select a date, a range of dates, or multiple ranges of dates.|Use the .| |Specify dates that cannot be selected.|Use the property.| -|Specify the range of dates that the displays.|Use the and properties.| -|Specify whether the current date is highlighted.|Use the property. By default, is `true`.| -|Change the size of the .|Use a or set the property to a . Note that if you set the and properties of a , the actual calendar does not change its size.| +|Specify the range of dates that the displays.|Use the and properties.| +|Specify whether the current date is highlighted.|Use the property. By default, is `true`.| +|Change the size of the .|Use a or set the property to a . Note that if you set the and properties of a , the actual calendar does not change its size.| The control provides basic navigation using either the mouse or keyboard. The following table summarizes keyboard navigation. -|Key Combination||Action| +|Key Combination||Action| |---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|------------| |ARROW||Changes the property if the property is not set to .| -|ARROW||Changes the month of the property. Note that the does not change.| -|ARROW||Changes the year of the . Note that the does not change.| -|SHIFT+ARROW||If is not set to or , extends the range of selected dates.| -|HOME||Changes the to the first day of the current month.| -|HOME||Changes the month of the to the first month of the year. The does not change.| -|HOME||Changes the year of the to the first year of the decade. The does not change.| -|END||Changes the to the last day of the current month.| -|END||Changes the month of the to the last month of the year. The does not change.| -|END||Changes the year of the to the last year of the decade. The does not change.| -|CTRL+UP ARROW|Any|Switches to the next larger . If is already , no action.| -|CTRL+DOWN ARROW|Any|Switches to the next smaller . If is already , no action.| -|SPACEBAR or ENTER| or |Switches to the or represented by focused item.| +|ARROW||Changes the month of the property. Note that the does not change.| +|ARROW||Changes the year of the . Note that the does not change.| +|SHIFT+ARROW||If is not set to or , extends the range of selected dates.| +|HOME||Changes the to the first day of the current month.| +|HOME||Changes the month of the to the first month of the year. The does not change.| +|HOME||Changes the year of the to the first year of the decade. The does not change.| +|END||Changes the to the last day of the current month.| +|END||Changes the month of the to the last month of the year. The does not change.| +|END||Changes the year of the to the last year of the decade. The does not change.| +|CTRL+UP ARROW|Any|Switches to the next larger . If is already , no action.| +|CTRL+DOWN ARROW|Any|Switches to the next smaller . If is already , no action.| +|SPACEBAR or ENTER| or |Switches to the or represented by focused item.| ## Customizing the Calendar Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [Calendar Styles and Templates](/dotnet/framework/wpf/controls/calendar-styles-and-templates). @@ -163,7 +163,7 @@ Calendar controls ## Remarks Dates in this collection will appear gray and crossed out on the calendar. - To make all past dates not selectable, you can use the method provided by the collection returned by this property. + To make all past dates not selectable, you can use the method provided by the collection returned by this property. ## XAML Property Element Usage @@ -482,15 +482,15 @@ Calendar with dates that cannot be selected and properties specify what the calendar displays and what has focus within the calendar. The user can change the only when is set to Month, but the user might change the when the Calendar is in Year and Decade mode. The following table describes how the mode changes the . + The and properties specify what the calendar displays and what has focus within the calendar. The user can change the only when is set to Month, but the user might change the when the Calendar is in Year and Decade mode. The following table describes how the mode changes the . |DisplayMode|Action| |-----------------|------------| -|Month| changes when the user navigates to a different month.| -|Year|The month of changes when the user clicks or navigates to a different month.| -|Decade|The year of changes when the user clicks or navigates to another year.| +|Month| changes when the user navigates to a different month.| +|Year|The month of changes when the user clicks or navigates to a different month.| +|Decade|The year of changes when the user clicks or navigates to another year.| - is ignored if its value is outside of the range of dates that is specified by and properties. + is ignored if its value is outside of the range of dates that is specified by and properties. ## Dependency Property Information @@ -498,7 +498,7 @@ Calendar with dates that cannot be selected | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -554,7 +554,7 @@ Calendar with dates that cannot be selected is assigned its new value. + This event occurs after is assigned its new value. ## XAML Attribute Usage @@ -603,7 +603,7 @@ Calendar with dates that cannot be selected by setting the and properties. A user cannot scroll to or select dates outside of this range. If you set the property to a date that is after , is set to the same value as . + You can restrict the range of a by setting the and properties. A user cannot scroll to or select dates outside of this range. If you set the property to a date that is after , is set to the same value as . ## Dependency Property Information @@ -611,7 +611,7 @@ Calendar with dates that cannot be selected | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -722,7 +722,7 @@ Calendar with dates that cannot be selected and properties. A user cannot scroll to or select dates outside of this range. If you set the property to a date that is before , is set to the same value as . + You can restrict the range of a Calendar by setting the and properties. A user cannot scroll to or select dates outside of this range. If you set the property to a date that is before , is set to the same value as . ## Dependency Property Information @@ -730,7 +730,7 @@ Calendar with dates that cannot be selected | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -828,12 +828,12 @@ Calendar with dates that cannot be selected | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . + The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet4"::: @@ -886,7 +886,7 @@ Calendar with dates that cannot be selected ## Examples - The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . + The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet4"::: @@ -1121,7 +1121,7 @@ Calendar with dates that cannot be selected method. + This method is invoked whenever application code or an internal process, such as rebuilding layout pass, calls the method. ]]> @@ -1263,7 +1263,7 @@ Calendar with dates that cannot be selected overrides the method to support keyboard navigation. For more information, see the class. This implementation marks the event as handled by setting the property of the event data to `true` when a keystroke, such as pressing an ARROW key, performs a navigation action. + overrides the method to support keyboard navigation. For more information, see the class. This implementation marks the event as handled by setting the property of the event data to `true` when a keystroke, such as pressing an ARROW key, performs a navigation action. ]]> @@ -1304,7 +1304,7 @@ Calendar with dates that cannot be selected overrides the method to support keyboard navigation. For more information, see the class. This implementation does not change the handled state (the property) of the event data. + overrides the method to support keyboard navigation. For more information, see the class. This implementation does not change the handled state (the property) of the event data. ]]> @@ -1345,7 +1345,7 @@ Calendar with dates that cannot be selected event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1424,9 +1424,9 @@ Calendar with dates that cannot be selected | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| - Use this property when is set to . In other modes, this property will always be the first date in . + Use this property when is set to . In other modes, this property will always be the first date in . ## XAML Attribute Usage @@ -1521,14 +1521,14 @@ Calendar with dates that cannot be selected method. Depending on the value of the property, adding a date or range to the collection may cause it to be cleared. The following table lists how affects the property. + Dates can be added to the collection either individually or in a range using the method. Depending on the value of the property, adding a date or range to the collection may cause it to be cleared. The following table lists how affects the property. |CalendarSelectionMode|Description| |---------------------------|-----------------| -||No selections are allowed. cannot be set and no values can be added to .| -||Only a single date can be selected, either by setting or the first value in . cannot be used.| -||A single range of dates can be selected. Setting , adding a date individually to , or using will clear all previous values from .| -||Multiple non-contiguous ranges of dates can be selected. Adding a date individually to or using will not clear . Setting will still clear , but additional dates or ranges can then be added. Adding a range that includes some dates that are already selected or overlaps with another range results in the union of the ranges and does not cause an exception.| +||No selections are allowed. cannot be set and no values can be added to .| +||Only a single date can be selected, either by setting or the first value in . cannot be used.| +||A single range of dates can be selected. Setting , adding a date individually to , or using will clear all previous values from .| +||Multiple non-contiguous ranges of dates can be selected. Adding a date individually to or using will not clear . Setting will still clear , but additional dates or ranges can then be added. Adding a range that includes some dates that are already selected or overlaps with another range results in the union of the ranges and does not cause an exception.| ## XAML Property Element Usage diff --git a/xml/System.Windows.Controls/CalendarBlackoutDatesCollection.xml b/xml/System.Windows.Controls/CalendarBlackoutDatesCollection.xml index 7bd0df516cf..5565ee85174 100644 --- a/xml/System.Windows.Controls/CalendarBlackoutDatesCollection.xml +++ b/xml/System.Windows.Controls/CalendarBlackoutDatesCollection.xml @@ -26,42 +26,42 @@ Represents a collection of non-selectable dates in a . - contains objects that specify multiple dates that cannot be selected by a user. To make all past dates not selectable, you can use the method. - - -## XAML Property Element Usage - -``` - - - oneOrMoreCalendarDateRanges - - - -``` - - -## XAML Values - *oneOrMoreCalendarDateRanges* - One or more object elements of type . - - - -## Examples - The following example creates a in code and markup that has some dates that cannot be selected. - + contains objects that specify multiple dates that cannot be selected by a user. To make all past dates not selectable, you can use the method. + + +## XAML Property Element Usage + +``` + + + oneOrMoreCalendarDateRanges + + + +``` + + +## XAML Values + *oneOrMoreCalendarDateRanges* + One or more object elements of type . + + + +## Examples + The following example creates a in code and markup that has some dates that cannot be selected. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet3"::: - :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet3"::: - - The preceding example produces output that is similar to the following illustration. - - ![Calendar with dates that cannot be selected.](~/add/media/ndp-calendarblackout.png "Calendar with dates that cannot be selected.") -Calendar with dates that cannot be selected - + :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet3"::: + + The preceding example produces output that is similar to the following illustration. + + ![Calendar with dates that cannot be selected.](~/add/media/ndp-calendarblackout.png "Calendar with dates that cannot be selected.") +Calendar with dates that cannot be selected + ]]> @@ -120,23 +120,23 @@ Calendar with dates that cannot be selected Adds all dates before to the collection. - that includes a event handler. - - :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet6"::: - - The following example shows the event handler. The event handler calls the method to make only future dates selectable. - + that includes a event handler. + + :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet6"::: + + The following example shows the event handler. The event handler calls the method to make only future dates selectable. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet7"::: + ]]> diff --git a/xml/System.Windows.Controls/CalendarMode.xml b/xml/System.Windows.Controls/CalendarMode.xml index 100da8baf3b..65a155e020d 100644 --- a/xml/System.Windows.Controls/CalendarMode.xml +++ b/xml/System.Windows.Controls/CalendarMode.xml @@ -22,29 +22,29 @@ Specifies whether a displays a month, year, or decade. - can display a month, a year, or a decade at a time. The following table lists how the user navigates to each mode. - -|DisplayMode|Action| -|-----------------|------------| -|Month|To navigate to Year mode, click the month heading.| -|Year|To navigate to Decade mode, click the year heading. To navigate to Month mode, click one of the displayed months.| -|Decade|To navigate to Year mode, click one of the displayed years.| - - - -## Examples - The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . - + can display a month, a year, or a decade at a time. The following table lists how the user navigates to each mode. + +|DisplayMode|Action| +|-----------------|------------| +|Month|To navigate to Year mode, click the month heading.| +|Year|To navigate to Decade mode, click the year heading. To navigate to Month mode, click one of the displayed months.| +|Decade|To navigate to Year mode, click one of the displayed years.| + + + +## Examples + The following example creates a calendar that displays the months in a year and handles the event so that when the user clicks on a month or the year, the calendar does not change its . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet4"::: - :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet4"::: - + :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet4"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Calendar/Overview/window1.xaml.vb" id="Snippet5"::: + ]]> diff --git a/xml/System.Windows.Controls/Canvas.xml b/xml/System.Windows.Controls/Canvas.xml index 3770eb456e0..70fcbaf2925 100644 --- a/xml/System.Windows.Controls/Canvas.xml +++ b/xml/System.Windows.Controls/Canvas.xml @@ -30,11 +30,11 @@ ## Remarks A contains a collection of objects, which are in the property. - is the only panel element that has no inherent layout characteristics. A has default and properties of zero, unless it is the child of an element that automatically sizes its child elements. Child elements of a are never resized, they are just positioned at their designated coordinates. This provides flexibility for situations in which inherent sizing constraints or alignment are not needed or wanted. For cases in which you want child content to be automatically resized and aligned, it is usually best to use a element. + is the only panel element that has no inherent layout characteristics. A has default and properties of zero, unless it is the child of an element that automatically sizes its child elements. Child elements of a are never resized, they are just positioned at their designated coordinates. This provides flexibility for situations in which inherent sizing constraints or alignment are not needed or wanted. For cases in which you want child content to be automatically resized and aligned, it is usually best to use a element. - The property determines the order in which child elements that share the same coordinate space appear. A higher value for one child element indicates that this element will appear above another child element that has a lower value. + The property determines the order in which child elements that share the same coordinate space appear. A higher value for one child element indicates that this element will appear above another child element that has a lower value. - If you specify them, the attached properties or take priority over the or properties. + If you specify them, the attached properties or take priority over the or properties. Child elements of a are always given the full size that they desire. As a result, vertical alignment and horizontal alignment have no effect inside a . @@ -146,9 +146,9 @@ offset of a child element does not affect the size of a parent . + The offset of a child element does not affect the size of a parent . - If you specify them, the attached properties or take priority over the or properties. + If you specify them, the attached properties or take priority over the or properties. ## Dependency Property Information @@ -445,9 +445,9 @@ offset of a child element does not affect the size of a parent . + The offset of a child element does not affect the size of a parent . - If you specify them, the attached properties or take priority over or properties. + If you specify them, the attached properties or take priority over or properties. ## Dependency Property Information @@ -551,9 +551,9 @@ offset of a child element does not affect the size of a parent . + The offset of a child element does not affect the size of a parent . - If you specify them, the attached properties or take priority over or properties. + If you specify them, the attached properties or take priority over or properties. ## Dependency Property Information @@ -763,9 +763,9 @@ offset of a child element does not affect the size of a parent . + The offset of a child element does not affect the size of a parent . - If you specify them, the attached properties or take priority over or . + If you specify them, the attached properties or take priority over or . ## Dependency Property Information diff --git a/xml/System.Windows.Controls/CheckBox.xml b/xml/System.Windows.Controls/CheckBox.xml index de017925c4d..9224cd7ad44 100644 --- a/xml/System.Windows.Controls/CheckBox.xml +++ b/xml/System.Windows.Controls/CheckBox.xml @@ -190,7 +190,7 @@ ## Remarks This implementation marks the event as handled by setting the property of the event data to `true` when the user presses the plus or the minus key. - This method sets to `true` when the user presses the plus key and to `false` when the user presses the minus key. + This method sets to `true` when the user presses the plus key and to `false` when the user presses the minus key. ]]> diff --git a/xml/System.Windows.Controls/CleanUpVirtualizedItemEventArgs.xml b/xml/System.Windows.Controls/CleanUpVirtualizedItemEventArgs.xml index 6ff4de86957..d57d77f634b 100644 --- a/xml/System.Windows.Controls/CleanUpVirtualizedItemEventArgs.xml +++ b/xml/System.Windows.Controls/CleanUpVirtualizedItemEventArgs.xml @@ -54,11 +54,11 @@ The that represents the data value. Initializes a new instance of the class. - @@ -136,11 +136,11 @@ Gets an instance of the visual element that represents the data value. The that represents the data value. - is a visual element, its property value will be the same as . - + is a visual element, its property value will be the same as . + ]]> @@ -178,11 +178,11 @@ Gets an that represents the original data value. The that represents the original data value. - is a visual element, its property value will be the same as . - + is a visual element, its property value will be the same as . + ]]> diff --git a/xml/System.Windows.Controls/ColumnDefinition.xml b/xml/System.Windows.Controls/ColumnDefinition.xml index 1d2040faf5a..f5610e7a309 100644 --- a/xml/System.Windows.Controls/ColumnDefinition.xml +++ b/xml/System.Windows.Controls/ColumnDefinition.xml @@ -91,7 +91,7 @@ ## Remarks This property is a calculated value that is based on other width inputs and the layout system. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ]]> @@ -133,9 +133,9 @@ value takes precedence over the value, which in turn takes precedence over the value. + When you use these values together in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ## XAML Attribute Usage @@ -250,9 +250,9 @@ value takes precedence over the value, which in turn takes precedence over the value. + When you use these values together in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns , the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns , the for all elements and the of all elements becomes zero until is called. ## XAML Attribute Usage @@ -392,7 +392,7 @@ ## Remarks The default is . - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/ColumnDefinitionCollection.xml b/xml/System.Windows.Controls/ColumnDefinitionCollection.xml index 121dc2266f3..5d4338c6952 100644 --- a/xml/System.Windows.Controls/ColumnDefinitionCollection.xml +++ b/xml/System.Windows.Controls/ColumnDefinitionCollection.xml @@ -90,7 +90,7 @@ method to add a to a . + The following example demonstrates how to use the method to add a to a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet11"::: @@ -136,7 +136,7 @@ method to clear the content of a . + The following example demonstrates how to use the method to clear the content of a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet12"::: @@ -186,7 +186,7 @@ method to determine whether a exists in a . + The following example demonstrates how to use the method to determine whether a exists in a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet13"::: @@ -342,7 +342,7 @@ method to determine the index position of a within a . + The following example demonstrates how to use the method to determine the index position of a within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet14"::: @@ -397,7 +397,7 @@ ## Examples - The following example demonstrates how to use the method to insert a to a specific `index` position within a . + The following example demonstrates how to use the method to insert a to a specific `index` position within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet14"::: @@ -624,7 +624,7 @@ ## Examples - The following example demonstrates how to use the method to remove a to a at a specific `index` position. + The following example demonstrates how to use the method to remove a to a at a specific `index` position. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet15"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet15"::: @@ -676,7 +676,7 @@ ## Examples - The following example demonstrates how to use the method to remove a range of elements from a . + The following example demonstrates how to use the method to remove a range of elements from a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet16"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet16"::: @@ -761,7 +761,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Controls/ComboBox.xml b/xml/System.Windows.Controls/ComboBox.xml index 8967834251f..4cc3fec1cc6 100644 --- a/xml/System.Windows.Controls/ComboBox.xml +++ b/xml/System.Windows.Controls/ComboBox.xml @@ -48,23 +48,23 @@ ## Remarks The allows the user to select an item from a drop-down list or optionally to enter new text in the text box of the control. is an , which means it can contain a collection of objects of any type (such as string, image, or panel). For more information, see the class. - The and properties specify how the behaves when the user does one of the following: + 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. - The following table describes the actions the user can and can't take, depending on the values of and . + The following table describes the actions the user can and can't take, depending on the values of and . | 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`. + The property has an effect only if is `true`. - The is an , so it can display content other than simple strings. For example, you can create a that contains a list of images. When you have content other than strings in the , a nonsensical string might appear in the when the drop-down list is hidden. To display a string in the when it contains non-string items, use the or attached property. + The is an , so it can display content other than simple strings. For example, you can create a that contains a list of images. When you have content other than strings in the , a nonsensical string might appear in the when the drop-down list is hidden. To display a string in the when it contains non-string items, use the or attached property. ## Customizing the ComboBox Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [ComboBox Styles and Templates](/dotnet/framework/wpf/controls/combobox-styles-and-templates). @@ -255,7 +255,7 @@ in its style and has a custom keyboard scrolling behavior, should return `true`. + If the control has a in its style and has a custom keyboard scrolling behavior, should return `true`. ]]> @@ -342,7 +342,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|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. @@ -412,21 +412,21 @@ and properties specify how the behaves when the user does one of the following: + 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. - The following table describes the actions the user can and cannot take, depending on the values of and . + The following table describes the actions the user can and cannot take, depending on the values of and . -| value | is `true`| is `false`| +| 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. + 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. ## Dependency Property Information @@ -437,7 +437,7 @@ |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. + 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. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ComboBox/IsEditable/pane1.xaml" id="Snippet1"::: @@ -445,7 +445,7 @@ Another solution is to use the property. The drop-down control of the will not display the images but will display the text you assigned. - The following example shows how to use . + The following example shows how to use . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ComboBox/IsEditable/pane1.xaml" id="Snippet3"::: @@ -546,21 +546,21 @@ and properties specify how the behaves when the user does one of the following: + 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. - The following table describes the actions the user can and cannot take, depending on the values of and . + The following table describes the actions the user can and cannot take, depending on the values of and . -| value | is `true`| is `false`| +| 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. + 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. ## Dependency Property Information @@ -568,7 +568,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|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 . @@ -638,7 +638,7 @@ is not public. Therefore, you cannot use the backing dependency property for property system operations that require the dependency property identifier, such as calls to . However, you can still use as a property trigger. + This property is a dependency property. However, the dependency property identifier field for is not public. Therefore, you cannot use the backing dependency property for property system operations that require the dependency property identifier, such as calls to . However, you can still use as a property trigger. ]]> @@ -1391,7 +1391,7 @@ that matches one of its items, the item is selected and the text that the user typed is replaced. This can cause the text that the user entered to change case. If the property is set to `true`, the selects the matching item, but preserves the text that the user entered. For example, suppose that a contains the string, "Hello" (with a capital H) and the user enters "hello" (with a lowercase h). If is `false`, the selects the matching item, "Hello," in its collection and populates its text box with that string. If is `true`, "Hello" is selected from the collection, but the text box says "hello." + By default, when the user types a string into the that matches one of its items, the item is selected and the text that the user typed is replaced. This can cause the text that the user entered to change case. If the property is set to `true`, the selects the matching item, but preserves the text that the user entered. For example, suppose that a contains the string, "Hello" (with a capital H) and the user enters "hello" (with a lowercase h). If is `false`, the selects the matching item, "Hello," in its collection and populates its text box with that string. If is `true`, "Hello" is selected from the collection, but the text box says "hello." ## Dependency Property Information @@ -1539,7 +1539,7 @@ property is `true`, setting this property places initial text entered in the text box. When is `false`, setting this value has no effect. + When the property is `true`, setting this property places initial text entered in the text box. When is `false`, setting this value has no effect. ## Dependency Property Information @@ -1547,7 +1547,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|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.Controls/ComboBoxItem.xml b/xml/System.Windows.Controls/ComboBoxItem.xml index dd2e61df730..964d03f63b8 100644 --- a/xml/System.Windows.Controls/ComboBoxItem.xml +++ b/xml/System.Windows.Controls/ComboBoxItem.xml @@ -36,7 +36,7 @@ ## Remarks > [!NOTE] -> By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the panel's default is applied and the item will be centered. +> By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the panel's default is applied and the item will be centered. A is a , which means that it can contain a single object of any type (such as a string, an image, or a panel). For more information, see the class. @@ -117,7 +117,7 @@ ## Remarks This property can be used by styles that need a highlight to indicate selection. - Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + Starting with the .NET Framework version 3.0 Service Pack 1, has a protected setter. To use this functionality, your application should target the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Dependency Property Information @@ -130,7 +130,7 @@ ## Examples - The following example changes the appearance of a when is `true`. + The following example changes the appearance of a when is `true`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ComboBox/DropDownClosed/Pane1.xaml" id="Snippet1"::: diff --git a/xml/System.Windows.Controls/ContentControl.xml b/xml/System.Windows.Controls/ContentControl.xml index 78f2d05a65d..8923db3e7c5 100644 --- a/xml/System.Windows.Controls/ContentControl.xml +++ b/xml/System.Windows.Controls/ContentControl.xml @@ -224,7 +224,7 @@ Four buttons with different types of content property is of type , there are no restrictions on what you can put in a . The is displayed by a , which is in the of the . Every type in WPF has a in its default . For more information about how the displays , see . + Because the property is of type , there are no restrictions on what you can put in a . The is displayed by a , which is in the of the . Every type in WPF has a in its default . For more information about how the displays , see . ## Dependency Property Information @@ -256,7 +256,7 @@ Four buttons with different types of content ## Examples - The following example demonstrates how to create four controls with set to one of the following: + The following example demonstrates how to create four controls with set to one of the following: - A string. @@ -346,7 +346,7 @@ Four buttons with different types of content can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. @@ -534,9 +534,9 @@ Four buttons with different types of content ## Remarks Typically, you create a when you have more than one for the same type of objects and you want to supply your own logic to choose a to apply based on the properties of each data object. Note that if you have objects of different types you can set the property on the . If you do that, then there is no need to create a . Furthermore, if you have objects of the same type but with different properties, you can also consider using a or a data converter. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. + To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. - If both the and the properties are set, then this property is ignored. + If both the and the properties are set, then this property is ignored. ## XAML Attribute Usage diff --git a/xml/System.Windows.Controls/ContentPresenter.xml b/xml/System.Windows.Controls/ContentPresenter.xml index 11e83b325ef..cb24e1ca353 100644 --- a/xml/System.Windows.Controls/ContentPresenter.xml +++ b/xml/System.Windows.Controls/ContentPresenter.xml @@ -36,30 +36,30 @@ ## Remarks You typically use the in the of a to specify where the content is to be added. Every type has a in its default . - When a object is in a of a , the , , and properties get their values from the properties of the same names of the . You can have the property get the values of these properties from other properties of the templated parent by setting the property or binding to them. + When a object is in a of a , the , , and properties get their values from the properties of the same names of the . You can have the property get the values of these properties from other properties of the templated parent by setting the property or binding to them. - The uses the following logic to display the : + The uses the following logic to display the : - If the property on the is set, the applies that to the property and the resulting and its child elements, if any, are displayed. For more information about objects, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - If the property on the is set, the applies the appropriate to the property and the resulting and its child elements, if any, are displayed. -- If there is a associated with the type of , the applies that to the property and the resulting and its child elements, if any, are displayed. +- If there is a associated with the type of , the applies that to the property and the resulting and its child elements, if any, are displayed. -- If is a object, the is displayed. If the already has a parent, an exception occurs. +- If is a object, the is displayed. If the already has a parent, an exception occurs. -- If there is a that converts the type of to a , the uses that and the resulting is displayed. +- If there is a that converts the type of to a , the uses that and the resulting is displayed. -- If there is a that converts the type of to a string, the uses that and creates a to contain that string. The is displayed. +- If there is a that converts the type of to a string, the uses that and creates a to contain that string. The is displayed. - If the content is an , the value of the property is displayed in a . -- The calls the method on the and creates a to contain the string returned by . The is displayed. +- The calls the method on the and creates a to contain the string returned by . The is displayed. ## Examples - The following shows a that sets the of a . The defines that the appears as an within a element. The marks that the of the should be displayed and centered vertically and horizontally within the . + The following shows a that sets the of a . The defines that the appears as an within a element. The marks that the of the should be displayed and centered vertically and horizontally within the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/Overview/Window1.xaml" id="Snippetbuttonct"::: @@ -165,15 +165,15 @@ ## Remarks The base class implements the following rules: -1. If is set, use it. +1. If is set, use it. -2. If is set, call its method. If the result is not `null`, use it. +2. If is set, call its method. If the result is not `null`, use it. -3. Look for a whose matches the content among the resources known to the (including application, theme, and system resources). If one is found, use it. +3. Look for a whose matches the content among the resources known to the (including application, theme, and system resources). If one is found, use it. -4. If the type of is "common", use a standard template. The common types are `String`, , and . +4. If the type of is "common", use a standard template. The common types are `String`, , and . -5. Otherwise, use a default template that essentially converts to a string and displays it in a . +5. Otherwise, use a default template that essentially converts to a string and displays it in a . Derived classes can override these rules and implement their own. @@ -211,7 +211,7 @@ in the of a , it automatically displays the of the templated control. This means that if you set the of your to be , the property of the is implicitly bound to the of the that is using that . + When you place a in the of a , it automatically displays the of the templated control. This means that if you set the of your to be , the property of the is implicitly bound to the of the that is using that . To set up bindings for the properties, you may want to consider using the property. The property points to a property on the templated parent as well as aliases the associated template and template selector properties automatically. @@ -225,7 +225,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -289,7 +289,7 @@ is in a template. When a template contains a with set to "`Abc`", the , , and properties of the are automatically aliased to `Abc`, `AbcTemplate`, and `AbcTemplateSelector`, respectively. Beginning with the .NET Framework 3.5 Service Pack 1, setting to "`Abc`" also causes the property to be aliased to `AbcStringFormat`. + This property should only be used when the is in a template. When a template contains a with set to "`Abc`", the , , and properties of the are automatically aliased to `Abc`, `AbcTemplate`, and `AbcTemplateSelector`, respectively. Beginning with the .NET Framework 3.5 Service Pack 1, setting to "`Abc`" also causes the property to be aliased to `AbcStringFormat`. The two most useful values for this property are "Content" and "Header". @@ -376,7 +376,7 @@ can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. ## Dependency Property Information @@ -459,7 +459,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -530,7 +530,7 @@ property is set. For more information, see . + This property is ignored if the property is set. For more information, see . ## XAML Text Usage @@ -542,7 +542,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls/ContextMenu.xml b/xml/System.Windows.Controls/ContextMenu.xml index 25ed2ed02fa..d1706c43247 100644 --- a/xml/System.Windows.Controls/ContextMenu.xml +++ b/xml/System.Windows.Controls/ContextMenu.xml @@ -38,21 +38,21 @@ The properties of the class are used to define the position and behavior of the . - A or can have a . If you assign a to the or property, the class handles context menu operations in response to user interaction. Part of the work the does is opening the when the user clicks the right mouse button over the control. + A or can have a . If you assign a to the or property, the class handles context menu operations in response to user interaction. Part of the work the does is opening the when the user clicks the right mouse button over the control. The following properties are defined by the and classes. If any of these properties are set on both and the , the property value from the is used. -- +- -- +- - -- +- - -- +- A is automatically placed inside a control. This behavior cannot be changed. @@ -226,7 +226,7 @@ ## Remarks The property must be set to for the callback delegate to be used. - The delegate returns an array of possible points that are defined with respect to the . When the context menu is displayed, a point is chosen that maximizes the amount of the window that is visible. + The delegate returns an array of possible points that are defined with respect to the . When the context menu is displayed, a point is chosen that maximizes the amount of the window that is visible. The behavior is the same as it is for the popup. For more information, see [How to: Specify a Custom Popup Position](/dotnet/framework/wpf/controls/how-to-specify-a-custom-popup-position) and [Popup Placement Sample](https://github.com/dotnet/dotnet-api-docs/tree/main/snippets/csharp/System.Windows.Controls/ContextMenu/CustomPopupPlacementCallback). @@ -300,7 +300,7 @@ in its style and has a custom keyboard scrolling behavior, should return `true`. + If the control has a in its style and has a custom keyboard scrolling behavior, should return `true`. ]]> @@ -337,7 +337,7 @@ opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. + When the opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. ## Dependency Property Information @@ -431,7 +431,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -561,7 +561,7 @@ is set to `true`, mouse capture is set to the and its subtree. + When is set to `true`, mouse capture is set to the and its subtree. ## Dependency Property Information @@ -569,7 +569,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -955,9 +955,9 @@ is assigned to the or property, the changes this value of this property when the opens. If the user opens the by using the mouse, is set to . If the user opens the by using the keyboard, is set to . If you want to change the position of the , set the property on the or . + When the is assigned to the or property, the changes this value of this property when the opens. If the user opens the by using the mouse, is set to . If the user opens the by using the keyboard, is set to . If you want to change the position of the , set the property on the or . - You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1047,7 +1047,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1141,7 +1141,7 @@ is assigned to the or property, the changes this value of this property to the owning or when the opens. To use a different , set the property. + When the is assigned to the or property, the changes this value of this property to the owning or when the opens. To use a different , set the property. ## Dependency Property Information @@ -1370,7 +1370,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information diff --git a/xml/System.Windows.Controls/ContextMenuEventArgs.xml b/xml/System.Windows.Controls/ContextMenuEventArgs.xml index 856d64088c6..3a9e6592144 100644 --- a/xml/System.Windows.Controls/ContextMenuEventArgs.xml +++ b/xml/System.Windows.Controls/ContextMenuEventArgs.xml @@ -60,13 +60,13 @@ Gets the horizontal position of the mouse. The horizontal position of the mouse. - by setting the , , , , or properties does not affect the value of . - - When the user opens a context menu by using the keyboard, or when the context menu closes, the value of this property is -1. - + by setting the , , , , or properties does not affect the value of . + + When the user opens a context menu by using the keyboard, or when the context menu closes, the value of this property is -1. + ]]> @@ -104,13 +104,13 @@ Gets the vertical position of the mouse. The vertical position of the mouse. - by setting the , , , , or properties does not affect the value of . - - When the user opens a context menu by using the keyboard, or when the context menu closes, the value of this property is -1. - + by setting the , , , , or properties does not affect the value of . + + When the user opens a context menu by using the keyboard, or when the context menu closes, the value of this property is -1. + ]]> diff --git a/xml/System.Windows.Controls/ContextMenuService.xml b/xml/System.Windows.Controls/ContextMenuService.xml index ae93c64b25a..b47ed0d92e4 100644 --- a/xml/System.Windows.Controls/ContextMenuService.xml +++ b/xml/System.Windows.Controls/ContextMenuService.xml @@ -30,24 +30,24 @@ ## Remarks The class provides attached properties that can be used to specify the appearance and position of a context menu. Many of the properties in the class are also defined by the . Sometimes it is more convenient to set the properties by using the class than by setting the properties on a . For example, you can create a to be shared by multiple elements, but use the class to specify a different position of the for each element. The following properties are defined by the and classes. If any of these properties are set on both and the , the property value from the is used. -- +- -- +- - -- +- - -- +- You can also use the to display menus on disabled items. ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: @@ -679,7 +679,7 @@ opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. + When the opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. ## Dependency Property Information @@ -692,7 +692,7 @@ ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: @@ -754,7 +754,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -794,7 +794,7 @@ ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: @@ -931,7 +931,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -944,7 +944,7 @@ ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: @@ -1006,7 +1006,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1019,7 +1019,7 @@ ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: @@ -1081,7 +1081,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1595,7 +1595,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1635,7 +1635,7 @@ ## Examples - The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. + The following example assigns the same to two buttons and sets the , , , , and properties to set the to different positions for each button. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ContextMenuService/Overview/Pane1.xaml" id="Snippetsharedcontextmenu"::: diff --git a/xml/System.Windows.Controls/Control.xml b/xml/System.Windows.Controls/Control.xml index 76ec549a8f3..442d03f9083 100644 --- a/xml/System.Windows.Controls/Control.xml +++ b/xml/System.Windows.Controls/Control.xml @@ -36,27 +36,27 @@ A that does not have a is not visible in your application, and setting the following properties has no effect unless the references them explicitly: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- - A common way to use these properties is to bind an element in the to the property. For example, if you want your control to change color according to the value of the property, you can bind some property of an element in the to the . Use the [TemplateBinding Markup Extension](/dotnet/framework/wpf/advanced/templatebinding-markup-extension) to bind properties on a control to an element in the . + A common way to use these properties is to bind an element in the to the property. For example, if you want your control to change color according to the value of the property, you can bind some property of an element in the to the . Use the [TemplateBinding Markup Extension](/dotnet/framework/wpf/advanced/templatebinding-markup-extension) to bind properties on a control to an element in the . overrides the metadata of the property and sets its default to `true`. For more information, see [Dependency Properties Overview](/dotnet/framework/wpf/advanced/dependency-properties-overview) @@ -180,7 +180,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -276,7 +276,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -368,7 +368,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -464,7 +464,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -564,7 +564,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## XAML Attribute Usage @@ -595,7 +595,7 @@ `pt` is points; 1pt==(96/72) px - **Note** In many cases a double may be set to "Auto," but a does not render if set to "Auto". + **Note** In many cases a double may be set to "Auto," but a does not render if set to "Auto". @@ -687,7 +687,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -779,7 +779,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -871,7 +871,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -963,7 +963,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -1172,7 +1172,7 @@ is `false`, the control is excluded from tab navigation. + If is `false`, the control is excluded from tab navigation. ## Dependency Property Information @@ -1293,9 +1293,9 @@ . If you set the property to `true` in a event handler, subsequent events along the route will occur with set to `false`. This is a higher-level event for control consumers who want to be notified when the user double-clicks the control and to handle the event in an application. + Although this routed event seems to follow a bubbling route through an element tree, it actually is a direct routed event that is raised along the element tree by each . If you set the property to `true` in a event handler, subsequent events along the route will occur with set to `false`. This is a higher-level event for control consumers who want to be notified when the user double-clicks the control and to handle the event in an application. - Control authors who want to handle mouse double clicks should use the event when is equal to two. This will cause the state of to propagate appropriately in the case where another element in the element tree handles the event. + Control authors who want to handle mouse double clicks should use the event when is equal to two. This will cause the state of to propagate appropriately in the case where another element in the element tree handles the event. The class defines the and events, but not corresponding single-click events. To see if the user has clicked the control once, handle the event (or one of its counterparts) and check whether the property value is 1. @@ -1385,7 +1385,7 @@ event by calling the method. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling the method. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1427,7 +1427,7 @@ event by calling the method. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling the method. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1473,15 +1473,15 @@ ## Remarks The timing for changing the template is as follows: -1. The template is changed by a method call, a style trigger, or some other means. +1. The template is changed by a method call, a style trigger, or some other means. 2. The property value changes; the property-changed callback is called. 3. The old visual tree is removed. -4. An internal method is called which eventually calls the method. +4. An internal method is called which eventually calls the method. -5. Later, during a measure, is called and a new visual tree is attached. +5. Later, during a measure, is called and a new visual tree is attached. ]]> @@ -1537,7 +1537,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1610,9 +1610,9 @@ . If you set the property to `true` in a event handler, subsequent events along the route will occur with set to `false`, but the event will occur with set to `true`. This is a higher-level event for control consumers who want to be notified when the user double-clicks the control and to handle the event in an application. + Although this routed event seems to follow a tunneling route through an element tree, it actually is a direct routed event that is raised along the element tree by each . If you set the property to `true` in a event handler, subsequent events along the route will occur with set to `false`, but the event will occur with set to `true`. This is a higher-level event for control consumers who want to be notified when the user double-clicks the control and to handle the event in an application. - Control authors who want to handle mouse double clicks should use the event when is equal to two. This will cause the state of to propagate appropriately in the case where another element in the element tree handles the event. + Control authors who want to handle mouse double clicks should use the event when is equal to two. This will cause the state of to propagate appropriately in the case where another element in the element tree handles the event. The class defines the and events, but not corresponding single-click events. To see if the user has clicked the control once, handle the event (or one of its counterparts) and check whether the property value is 1. @@ -1804,7 +1804,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/DataErrorValidationRule.xml b/xml/System.Windows.Controls/DataErrorValidationRule.xml index c671d84e3ff..0693118725c 100644 --- a/xml/System.Windows.Controls/DataErrorValidationRule.xml +++ b/xml/System.Windows.Controls/DataErrorValidationRule.xml @@ -27,7 +27,7 @@ with a object. If your source object implements the interface, you can use the built-in rule to check for errors raised by the implementation. + The WPF data binding model enables you to associate with a object. If your source object implements the interface, you can use the built-in rule to check for errors raised by the implementation. An alternative syntax to setting the explicitly is to set the property to `true` on your or object. @@ -67,7 +67,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -109,7 +109,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Controls/DataGrid.xml b/xml/System.Windows.Controls/DataGrid.xml index cf85eaf637e..ab67316834c 100644 --- a/xml/System.Windows.Controls/DataGrid.xml +++ b/xml/System.Windows.Controls/DataGrid.xml @@ -30,7 +30,7 @@ The control provides a flexible way to display a collection of data in rows and columns. The includes built-in column types and a template column for hosting custom content. The built-in row type includes a drop-down details section that you can use to display additional content below the cell values. ## Binding to Data - To bind the to data, set the property to an implementation. Each row in the data grid is bound to an object in the data source, and each column in the data grid is bound to a property of the data object. In order for the user interface to update automatically when items are added to or removed from the source data, the must be bound to a collection that implements the interface, such as an . To automatically reflect property changes, the objects in the source collection must implement the interface. For more information, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). + To bind the to data, set the property to an implementation. Each row in the data grid is bound to an object in the data source, and each column in the data grid is bound to a property of the data object. In order for the user interface to update automatically when items are added to or removed from the source data, the must be bound to a collection that implements the interface, such as an . To automatically reflect property changes, the objects in the source collection must implement the interface. For more information, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). ## Columns By default, the control generates columns automatically when you set the property. The type of column that is generated depends on the type of data in the column. The following table lists the generated columns types. @@ -50,19 +50,19 @@ You can prevent automatic column generation by setting the property to `false`. This is useful if you want to create and configure all columns explicitly. - Use the type to define a custom column if the built-in column types do not meet your needs. The type provides and properties that enable you to specify content templates for both display and editing modes. For example, you could define a custom column for dates. The could define a to display a date, and the could define a control to edit the date. + Use the type to define a custom column if the built-in column types do not meet your needs. The type provides and properties that enable you to specify content templates for both display and editing modes. For example, you could define a custom column for dates. The could define a to display a date, and the could define a control to edit the date. - You can use the collection to programmatically add, insert, remove, and change any columns in the control at run time. Check the property to determine whether a column is auto generated or user defined. Auto-generated columns will be automatically added, removed, or regenerated when the changes. + You can use the collection to programmatically add, insert, remove, and change any columns in the control at run time. Check the property to determine whether a column is auto generated or user defined. Auto-generated columns will be automatically added, removed, or regenerated when the changes. ## Selection By default, the entire row is selected when a user clicks a cell in a , and a user can select multiple rows. You can set the property to specify whether a user can select cells, full rows, or both. Set the property to specify whether multiple rows or cells can be selected, or only single rows or cells. - You can get information about the cells that are selected from the property. You can get information about cells for which selection has changed in the of the event. Call the or methods to programmatically select or unselect all cells. For more information, see [Default Keyboard and Mouse Behavior in the DataGrid Control](/dotnet/framework/wpf/controls/default-keyboard-and-mouse-behavior-in-the-datagrid-control). + You can get information about the cells that are selected from the property. You can get information about cells for which selection has changed in the of the event. Call the or methods to programmatically select or unselect all cells. For more information, see [Default Keyboard and Mouse Behavior in the DataGrid Control](/dotnet/framework/wpf/controls/default-keyboard-and-mouse-behavior-in-the-datagrid-control). ## Grouping, Sorting, and Filtering By default, you can sort items in a by clicking the column header. You can customize sorting by handling the event. To cancel the default sort, set the property to `true`. You can also sort the source data before it is displayed in the . - To group, sort, and filter data in the , you bind the to an implementation that supports these operations. You then perform the operations on the collection view. When items are grouped in the , you can define a that specifies the appearance of each group. You apply the by adding it to the collection of the . If you have multiple levels of grouping, you can apply different styles to each group level. Styles are applied in the order in which they are defined. For more information, see [How to: Group, Sort, and Filter Data in the DataGrid Control](/dotnet/framework/wpf/controls/how-to-group-sort-and-filter-data-in-the-datagrid-control). + To group, sort, and filter data in the , you bind the to an implementation that supports these operations. You then perform the operations on the collection view. When items are grouped in the , you can define a that specifies the appearance of each group. You apply the by adding it to the collection of the . If you have multiple levels of grouping, you can apply different styles to each group level. Styles are applied in the order in which they are defined. For more information, see [How to: Group, Sort, and Filter Data in the DataGrid Control](/dotnet/framework/wpf/controls/how-to-group-sort-and-filter-data-in-the-datagrid-control). ## Editing By default, you can edit items directly in the . To guarantee that edits can be committed and canceled correctly, the objects in the must implement the interface. Alternatively, you can set the property to `true` to disable editing in the . @@ -74,17 +74,17 @@ ||F2| ||ESC| ||ENTER| -||DELETE| +||DELETE| - You put the current cell into edit mode by clicking it or pressing F2. A cell-level edit is committed when you move to another cell in the same row or press ENTER while the cell is in edit mode. All edits in a row are committed when you move to another row or press ENTER while the row is in edit mode. You cancel a cell edit by pressing ESC one time, and cancel all edits in a row by pressing ESC two times. For more information about programmatically committing and canceling edits, see the , , and methods. For more information about edit-related events, see , , , and . + You put the current cell into edit mode by clicking it or pressing F2. A cell-level edit is committed when you move to another cell in the same row or press ENTER while the cell is in edit mode. All edits in a row are committed when you move to another row or press ENTER while the row is in edit mode. You cancel a cell edit by pressing ESC one time, and cancel all edits in a row by pressing ESC two times. For more information about programmatically committing and canceling edits, see the , , and methods. For more information about edit-related events, see , , , and . - Set the and properties to specify whether a user can add or delete rows. A user can delete selected rows by pressing the DELETE key. If the property is set to `true`, a new item row is added as the last row in the . You can set default values for new items by handling the event. + Set the and properties to specify whether a user can add or delete rows. A user can delete selected rows by pressing the DELETE key. If the property is set to `true`, a new item row is added as the last row in the . You can set default values for new items by handling the event. > [!NOTE] -> Whether editing actions are allowed is influenced by a variety of additional factors, including the and state of the , and whether the underlying data collection allows the action. +> Whether editing actions are allowed is influenced by a variety of additional factors, including the and state of the , and whether the underlying data collection allows the action. ## Validation - The enables you to perform validation at both the cell and row level. With cell-level validation, you validate individual properties of a bound data object when a user updates a value. With row-level validation, you validate entire data objects when a user commits changes to a row. You can provide customized visual feedback for row-level validation errors by setting the property, or you can use the default error indicator. To create a custom validation rule, create a class that derives from the class and implement the method. Add the custom validation rule to the collection. + The enables you to perform validation at both the cell and row level. With cell-level validation, you validate individual properties of a bound data object when a user updates a value. With row-level validation, you validate entire data objects when a user commits changes to a row. You can provide customized visual feedback for row-level validation errors by setting the property, or you can use the default error indicator. To create a custom validation rule, create a class that derives from the class and implement the method. Add the custom validation rule to the collection. ## Customizing the DataGrid Control The control supports common table formatting options, such as alternating row backgrounds and the ability to show or hide headers, gridlines, and scroll bars. Additionally, the control provides several style and template properties that you can use to completely change the appearance of the control and its rows, columns, headers, and cells. @@ -102,29 +102,29 @@ |Task|Implementation| |----------|--------------------| -|Set alternating row background colors|Set the property to 2 or more, and then assign a to the and properties.| -|Define cell and row selection behavior|Set the and properties.| -|Customize the visual appearance of headers, cells and rows|Apply a new to the , , , or properties.| -|Set sizing options|Set the , , , , , or properties. For more information, see [Sizing Options in the DataGrid Control](/dotnet/framework/wpf/controls/sizing-options-in-the-datagrid-control).| +|Set alternating row background colors|Set the property to 2 or more, and then assign a to the and properties.| +|Define cell and row selection behavior|Set the and properties.| +|Customize the visual appearance of headers, cells and rows|Apply a new to the , , , or properties.| +|Set sizing options|Set the , , , , , or properties. For more information, see [Sizing Options in the DataGrid Control](/dotnet/framework/wpf/controls/sizing-options-in-the-datagrid-control).| |Access selected items|Check the property to get the selected cells and check the property to get the selected rows. For more information, see the property.| -|Customize end-user interactions|Set the , , , , , and properties.| +|Customize end-user interactions|Set the , , , , , and properties.| |Cancel or change auto-generated columns|Handle the event.| |Freeze a column|Set the property to 1 and move the column to the left-most position by setting the property to 0.| -|Use XML data as the data source|Bind the on the to the XPath query representing the collection of items. Create each column in the . Bind each column by setting the XPath on the binding to the query that gets the property on the item source. For an example, see .| +|Use XML data as the data source|Bind the on the to the XPath query representing the collection of items. Create each column in the . Bind each column by setting the XPath on the binding to the query that gets the property on the item source. For an example, see .| |Group items|Bind to a or that supports grouping. For more information, see [How to: Group, Sort, and Filter Data in the DataGrid Control](/dotnet/framework/wpf/controls/how-to-group-sort-and-filter-data-in-the-datagrid-control).| -|Display the details section for a row|Define a to specify the appearance of the details section. Set the to specify when the details section is shown. For more information, see [How to: Add Row Details to a DataGrid Control](/dotnet/framework/wpf/controls/how-to-add-row-details-to-a-datagrid-control).| +|Display the details section for a row|Define a to specify the appearance of the details section. Set the to specify when the details section is shown. For more information, see [How to: Add Row Details to a DataGrid Control](/dotnet/framework/wpf/controls/how-to-add-row-details-to-a-datagrid-control).| ## Examples - The following example shows how to bind a to a and use column auto-generation. The is populated by using the method of a from a . For more information, see [Creating a DataSet](/dotnet/framework/data/adonet/dataset-datatable-dataview/creating-a-dataset) and [Populating a DataSet from a DataAdapter](/dotnet/framework/data/adonet/populating-a-dataset-from-a-dataadapter). To use the WPF Designer for Visual Studio, see [Bind WPF controls to data in Visual Studio](/visualstudio/data-tools/bind-wpf-controls-to-data-in-visual-studio). + The following example shows how to bind a to a and use column auto-generation. The is populated by using the method of a from a . For more information, see [Creating a DataSet](/dotnet/framework/data/adonet/dataset-datatable-dataview/creating-a-dataset) and [Populating a DataSet from a DataAdapter](/dotnet/framework/data/adonet/populating-a-dataset-from-a-dataadapter). To use the WPF Designer for Visual Studio, see [Bind WPF controls to data in Visual Studio](/visualstudio/data-tools/bind-wpf-controls-to-data-in-visual-studio). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/Overview/window1.xaml" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/DataGrid/Overview/window1.xaml.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/DataGrid/Overview/window1.xaml.vb" id="Snippet2"::: - The following example shows how to create a with a customized collection. + The following example shows how to create a with a customized collection. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/Overview/window11.xaml" id="Snippetall1"::: @@ -228,9 +228,9 @@ , , and properties together determine the appearance of each row's background. + The , , and properties together determine the appearance of each row's background. - If is less than 2, setting the property sets to 2. + If is less than 2, setting the property sets to 2. @@ -372,12 +372,12 @@ to `true` or `false` creates or removes auto-generated columns. When the property is set to `true`, the event will be raised for each column that is created. You can change or cancel the column being created in the event handler. + Setting to `true` or `false` creates or removes auto-generated columns. When the property is set to `true`, the event will be raised for each column that is created. You can change or cancel the column being created in the event handler. When auto-generation of all columns is complete, the event is raised. > [!NOTE] -> cannot auto-generate columns when the source is XML data. In this case, create a custom collection. For an example, see . +> cannot auto-generate columns when the source is XML data. In this case, create a custom collection. For an example, see . @@ -453,7 +453,7 @@ If the property is set to `true`, the event is raised for each column created. When all columns are created, this event will occur. > [!NOTE] -> The event is raised every time the attempts to generate columns. For example, is raised when the is initialized, is set to `true`, or the is changed, even if the is `null`. +> The event is raised every time the attempts to generate columns. For example, is raised when the is initialized, is set to `true`, or the is changed, even if the is `null`. ]]> @@ -704,7 +704,7 @@ method cancels the cell edit, but not any pending row edits. If a cell is not in edit mode, cancels all pending row edits. + If a cell is currently in edit mode, the method cancels the cell edit, but not any pending row edits. If a cell is not in edit mode, cancels all pending row edits. ]]> @@ -807,7 +807,7 @@ . A user can enter a new item into the blank row. Adding a new row adds an item to the . You can set default values for the new item by handling the event and setting the values programmatically. + When this property is set to `true` a blank row is displayed at the bottom of the . A user can enter a new item into the blank row. Adding a new row adds an item to the . You can set default values for the new item by handling the event and setting the values programmatically. ]]> @@ -871,7 +871,7 @@ Delete key. Deleting a row removes the item that the row represents from the . If the does not allow deletions or if the is read-only, the user cannot delete rows even if this property is set to `true`. + By default, the user can delete rows by selecting one or more rows and pressing the Delete key. Deleting a row removes the item that the row represents from the . If the does not allow deletions or if the is read-only, the user cannot delete rows even if this property is set to `true`. ]]> @@ -1198,7 +1198,7 @@ ## Remarks You can cancel this event by setting the property of the `e` argument to `true` in the event handler. If canceled, the cell remains in edit mode. - If this event is not canceled, the specified will be performed to commit or cancel the edit. + If this event is not canceled, the specified will be performed to commit or cancel the edit. ]]> @@ -1299,14 +1299,14 @@ to update the visual appearance of all the cells in the . To define a for a cell, specify a of . + Apply a to update the visual appearance of all the cells in the . To define a for a cell, specify a of . A can be applied to a cell at the table, column, or cell level. To apply a to all cells in a column, set the property. This will take precedence over the property. To apply a to an individual cell, set the property directly on the . This will take precedence over all other styles applied to the cell. ## Examples - The following example uses a trigger to change the color of a when the cell is selected. + The following example uses a trigger to change the color of a when the cell is selected. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/CellStyle/window1.xaml" id="Snippet1"::: @@ -1512,7 +1512,7 @@ ## Remarks The property of a can be changed programmatically or when a user moves a column by dragging the header. Users can change the column order by dragging column headers only if the property is `true`. - If the of a column changes, the of all columns to the right of the column in the are also changed. + If the of a column changes, the of all columns to the right of the column in the are also changed. ]]> @@ -1776,14 +1776,14 @@ to update the visual appearance of all the column headers in the . To define a for a column header, specify a of . + Apply a to update the visual appearance of all the column headers in the . To define a for a column header, specify a of . A can be applied to all column headers, or to an individual column header. To apply a to an individual header, set the property, which takes precedence over the property. ## Examples - The following example uses a style resource to change the style of column headers in the . The style of the first column header is then set with an inline style that overrides the . + The following example uses a style resource to change the style of column headers in the . The style of the first column header is then set with an inline style that overrides the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/ColumnHeaderStyle/mainwindow.xaml" id="Snippet1"::: @@ -1895,7 +1895,7 @@ and properties. Alternatively, you can set the and properties. + You can handle this event to customize the visual display of a column header drag operation, or to replace the default drag behavior completely. To customize the appearance of the dragged column header and the drop location indicator, set the and properties. Alternatively, you can set the and properties. ]]> @@ -1943,12 +1943,12 @@ collection to add columns, remove columns, or update properties on the columns. + Use the collection to add columns, remove columns, or update properties on the columns. > [!NOTE] > The order of columns in the collection does not determine the order that they will appear in the . The property determines the column order. - Each column in the collection defines a column in the . The following table lists the four column types that the provides. + Each column in the collection defines a column in the . The following table lists the four column types that the provides. |Column Type|Data Display| |-----------------|------------------| @@ -1961,7 +1961,7 @@ All columns in the collection use the property defined by the . - You can modify the collection at run time regardless of whether it contains generated columns. + You can modify the collection at run time regardless of whether it contains generated columns. @@ -2026,15 +2026,15 @@ ## Remarks The property set on an individual takes precedence over the property. - The of the property is constrained by the following properties if they are set, in order of precedence: + The of the property is constrained by the following properties if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> @@ -2252,7 +2252,7 @@ ## Remarks The value returned is a structure that provides information about the cell and the data item associated with the cell. It is not an actual reference to the container. - To set properties on the selected cells, you can set a trigger in the property. For more information, see . + To set properties on the selected cells, you can set a trigger in the property. For more information, see . ]]> @@ -2413,7 +2413,7 @@ value returned by the property. + This property gets the data item for the row that either has focus, or contains the cell that has focus. It is equivalent to the value returned by the property. ]]> @@ -2504,9 +2504,9 @@ for the drag indicator, specify a of . + To define a for the drag indicator, specify a of . - You can set properties in the style to change the appearance of certain elements of the drag indicator, such as the border around the column header. However, the default template for the drag indicator uses a to paint a with an image of the original column header that is being dragged. As a result, if you set some properties in your style, such as or , they will appear to not be applied. To change the appearance of the column header while it is being dragged, apply a new template that does not use the default . + You can set properties in the style to change the appearance of certain elements of the drag indicator, such as the border around the column header. However, the default template for the drag indicator uses a to paint a with an image of the original column header that is being dragged. As a result, if you set some properties in your style, such as or , they will appear to not be applied. To change the appearance of the column header while it is being dragged, apply a new template that does not use the default . ]]> @@ -2568,7 +2568,7 @@ for the drop location indicator, specify a of . + To define a for the drop location indicator, specify a of . ]]> @@ -2790,7 +2790,7 @@ ## Remarks Frozen columns are columns that are always displayed and cannot be scrolled out of visibility. Frozen columns are always the leftmost columns in display order. You cannot drag frozen columns into the group of unfrozen columns or drag unfrozen columns into the group of frozen columns. - To freeze columns, set the property. The leftmost columns specified by the number will become frozen. For example, if you set the to 2, the two left columns in the display are frozen. To determine whether a column is already frozen, check the property on the . + To freeze columns, set the property. The leftmost columns specified by the number will become frozen. For example, if you set the to 2, the two left columns in the display are frozen. To determine whether a column is already frozen, check the property on the . @@ -2872,9 +2872,9 @@ ## Remarks Each row in the data grid is bound to an object in the data source, and each column in the data grid is bound to a property of the data object. This method generates a collection that contains a column for each property. - Calling the method provides the same functionality as setting the property to `true`. You will typically not call this method from your code. + Calling the method provides the same functionality as setting the property to `true`. You will typically not call this method from your code. - This method is provided to enable designer tools to generate a collection of columns that can be edited by the user and then placed into the data grid. A designer tool can use the method to return a collection of auto-generated columns. The designer tool can then provide a user interface to enable the user to edit the column types, and add or remove columns as necessary. The column collection can then be used to populate the collection of the data grid by adding each column to the collection. + This method is provided to enable designer tools to generate a collection of columns that can be edited by the user and then placed into the data grid. A designer tool can use the method to return a collection of auto-generated columns. The designer tool can then provide a user interface to enable the user to edit the column types, and add or remove columns as necessary. The column collection can then be used to populate the collection of the data grid by adding each column to the collection. ]]> @@ -2974,7 +2974,7 @@ and properties. + This property specifies whether the lines that separate rows and columns are visible. The appearance of the lines when they are visible is specified by the and properties. ]]> @@ -3074,7 +3074,7 @@ and properties. + This property specifies whether the row and column headers are visible. The appearance of the headers when they are visible is specified by the and properties. ]]> @@ -3511,15 +3511,15 @@ is not a valid value for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - The of the and properties are constrained by the following properties if they are set, in order of precedence: + The of the and properties are constrained by the following properties if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> @@ -3619,15 +3619,15 @@ and are not valid values for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - The of the and properties are constrained by the following properties if they are set, in order of precedence: + The of the and properties are constrained by the following properties if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> @@ -3695,7 +3695,7 @@ and are not valid values for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - If a conflict exists between the property and the property, takes precedence. However, the property set on an individual has higher precedence than a property set at the level and is not constrained by the property. + If a conflict exists between the property and the property, takes precedence. However, the property set on an individual has higher precedence than a property set at the level and is not constrained by the property. ]]> @@ -3949,7 +3949,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -3992,7 +3992,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4037,7 +4037,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4237,7 +4237,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4278,11 +4278,11 @@ requires that the property of all columns must be unique integers from 0 to -1. Therefore, when the of one column changes, the change will typically cause the of other columns to change too. + requires that the property of all columns must be unique integers from 0 to -1. Therefore, when the of one column changes, the change will typically cause the of other columns to change too. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4325,7 +4325,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4368,7 +4368,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4411,7 +4411,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4454,7 +4454,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4497,7 +4497,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4652,7 +4652,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -4864,7 +4864,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5048,7 +5048,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5091,7 +5091,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5167,7 +5167,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5210,7 +5210,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5255,7 +5255,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5298,7 +5298,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5381,7 +5381,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5496,7 +5496,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5539,7 +5539,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -5741,12 +5741,12 @@ You define the row details template as either inline XAML or as a resource. A data template that is added as a resource can be used throughout the project without re-creating the template. A data template that is added as inline XAML is only accessible from the control where it is defined. - You can modify the before it is displayed by handling the event. You should handle the event to undo changes that are made while loading the row details. + You can modify the before it is displayed by handling the event. You should handle the event to undo changes that are made while loading the row details. ## Examples - The following example shows a with a defined inline. The displays three values in each row and three more values in the details section when the row is selected. This example is part of a larger example available in the [How to: Add Row Details to a DataGrid Control](/dotnet/framework/wpf/controls/how-to-add-row-details-to-a-datagrid-control) topic. + The following example shows a with a defined inline. The displays three values in each row and three more values in the details section when the row is selected. This example is part of a larger example available in the [How to: Add Row Details to a DataGrid Control](/dotnet/framework/wpf/controls/how-to-add-row-details-to-a-datagrid-control) topic. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/RowDetailsTemplate/mainwindow.xaml" id="Snippet1"::: @@ -5904,7 +5904,7 @@ is defined. Set this property to to show the details for all rows or to hide the details for all rows. + By default, the row details section is displayed for selected rows if a is defined. Set this property to to show the details for all rows or to hide the details for all rows. The event occurs when this property is changed. @@ -5973,7 +5973,7 @@ ## Remarks You can cancel this event by setting the property of the `e` argument to `true` in the event handler. If canceled, the row remains in edit mode. - If this event is not canceled, the specified will be performed to commit or cancel the edit. + If this event is not canceled, the specified will be performed to commit or cancel the edit. ]]> @@ -6074,7 +6074,7 @@ to update the visual appearance of all the row headers in the . To define a for a row header, specify a of . + Apply a to update the visual appearance of all the row headers in the . To define a for a row header, specify a of . You can also use the property to update any property of . @@ -6151,7 +6151,7 @@ property defines the for the . The does not inherit the data context from the . To set the row header content to display values based on the row data, bind to the property of the by using the property. For more information, see . + The property defines the for the . The does not inherit the data context from the . To set the row header content to display values based on the row data, bind to the property of the by using the property. For more information, see . ]]> @@ -6337,9 +6337,9 @@ is not a valid value for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - The property is applied to each that does not have its property set. If a conflict exists between the property and the property, takes precedence. + The property is applied to each that does not have its property set. If a conflict exists between the property and the property, takes precedence. - Setting tells the layout system the amount of space requested by each row. The return value of this property is always the value that it was set to. To get the actual amount of space allocated, use the property of the . For more information about space allocation, see [Layout](/dotnet/framework/wpf/advanced/layout). + Setting tells the layout system the amount of space requested by each row. The return value of this property is always the value that it was set to. To get the actual amount of space allocated, use the property of the . For more information about space allocation, see [Layout](/dotnet/framework/wpf/advanced/layout). ]]> @@ -6403,7 +6403,7 @@ to change the visual appearance of all rows in the . To define a for a row, specify a of . + Apply a to change the visual appearance of all rows in the . To define a for a row, specify a of . A can be applied to all rows in the or to an individual row. To apply a to an individual row, set the property directly on the , which takes precedence over the property. @@ -6412,7 +6412,7 @@ ## Examples - The following example sets the color of all the rows and uses a trigger to change the and colors when the mouse pointer is over the row. + The following example sets the color of all the rows and uses a trigger to change the and colors when the mouse pointer is over the row. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/RowStyle/mainwindow.xaml" id="Snippet1"::: @@ -6618,7 +6618,7 @@ control enables you to perform validation at both the cell and row level. With cell-level validation, you validate individual properties of a bound data object when a user updates a value. With row-level validation, you validate entire data objects when a user commits changes to a row. To create a custom validation rule, create a class that derives from the class and implement the method. Add the custom validation rule to the collection. + The control enables you to perform validation at both the cell and row level. With cell-level validation, you validate individual properties of a bound data object when a user updates a value. With row-level validation, you validate entire data objects when a user commits changes to a row. To create a custom validation rule, create a class that derives from the class and implement the method. Add the custom validation rule to the collection. If the property is used, the property is ignored. @@ -6821,17 +6821,17 @@ . The selection mode is set with the property. Depending on the , or will contain a collection of selected items as defined in the following table. + There are three selection modes for . The selection mode is set with the property. Depending on the , or will contain a collection of selected items as defined in the following table. -| value| value| value| +| value| value| value| |------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ||Collection of selected cells|Empty| ||Collection of cells in the selected rows|Collection of selected rows| ||Collection of selected cells, including all cells in a selected row|Collection of selected rows or empty if no full rows are selected| - When a cell is selected, the event is raised, the property is set to `true`, and the cell is added to the collection. + When a cell is selected, the event is raised, the property is set to `true`, and the cell is added to the collection. - When a row is selected, the event is raised, the property is set to `true`, and the row is added to the collection. + When a row is selected, the event is raised, the property is set to `true`, and the row is added to the collection. When the selection changes, the and events are raised if the new or old selection contains a row. The event is not raised if the new or old selection contains only cells. @@ -6870,7 +6870,7 @@ ## Remarks You can handle the event to be notified when the collection of selected cells is changed. If the selection includes full rows, the event is also raised. - You can retrieve the and from the in the event handler. + You can retrieve the and from the in the event handler. @@ -6919,7 +6919,7 @@ and properties together define the selection behavior for the . + The and properties together define the selection behavior for the . If the selection mode is , the user can select multiple items where the item type is defined by the property. If the selection mode is , the user can only select single items. @@ -6983,7 +6983,7 @@ and properties together define the selection behavior for the . + The and properties together define the selection behavior for the . ]]> @@ -7050,7 +7050,7 @@ method when a does not currently exist for an `item`; for example, while a row is being auto-generated. + Use the method when a does not currently exist for an `item`; for example, while a row is being auto-generated. ]]> diff --git a/xml/System.Windows.Controls/DataGridBoundColumn.xml b/xml/System.Windows.Controls/DataGridBoundColumn.xml index ccaaee450e2..b8919dc54c8 100644 --- a/xml/System.Windows.Controls/DataGridBoundColumn.xml +++ b/xml/System.Windows.Controls/DataGridBoundColumn.xml @@ -92,7 +92,7 @@ property allows a column to specify a property of the data grid's to bind to. For more information about binding paths, see the "Binding Path Syntax" section in [Binding Declarations Overview](/dotnet/framework/wpf/data/binding-declarations-overview). + The property allows a column to specify a property of the data grid's to bind to. For more information about binding paths, see the "Binding Path Syntax" section in [Binding Declarations Overview](/dotnet/framework/wpf/data/binding-declarations-overview). ]]> diff --git a/xml/System.Windows.Controls/DataGridCell.xml b/xml/System.Windows.Controls/DataGridCell.xml index 4d944714e2d..7cbe1c170a7 100644 --- a/xml/System.Windows.Controls/DataGridCell.xml +++ b/xml/System.Windows.Controls/DataGridCell.xml @@ -83,7 +83,7 @@ method determines the arrangement of the cell content with a gridline on the right. + The method determines the arrangement of the cell content with a gridline on the right. ]]> @@ -363,7 +363,7 @@ method measures the area needed for the cell and the gridline on the right. + The method measures the area needed for the cell and the gridline on the right. ]]> @@ -521,7 +521,7 @@ that contains the cell. Each column handles the input in a way that is appropriate for the column type. + This method passes keyboard input to the that contains the cell. Each column handles the input in a way that is appropriate for the column type. ]]> @@ -559,7 +559,7 @@ that contains the cell. Each column handles the input in a way that is appropriate for the column type. + This method passes keyboard input to the that contains the cell. Each column handles the input in a way that is appropriate for the column type. ]]> @@ -630,7 +630,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -677,7 +677,7 @@ that contains the cell. Each column handles the input in a way that is appropriate for the column type. + This method passes text input to the that contains the cell. Each column handles the input in a way that is appropriate for the column type. ]]> @@ -717,7 +717,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also enables derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> diff --git a/xml/System.Windows.Controls/DataGridCellInfo.xml b/xml/System.Windows.Controls/DataGridCellInfo.xml index 2d5d8d4c144..eb9123eee0d 100644 --- a/xml/System.Windows.Controls/DataGridCellInfo.xml +++ b/xml/System.Windows.Controls/DataGridCellInfo.xml @@ -26,7 +26,7 @@ container when the gets a cell; for example, in the or properties. + This structure provides information about the cell and the data item associated with the cell. It is used instead of a reference to the actual container when the gets a cell; for example, in the or properties. ]]> diff --git a/xml/System.Windows.Controls/DataGridCellsPanel.xml b/xml/System.Windows.Controls/DataGridCellsPanel.xml index e598f6996d6..dc245b00eff 100644 --- a/xml/System.Windows.Controls/DataGridCellsPanel.xml +++ b/xml/System.Windows.Controls/DataGridCellsPanel.xml @@ -24,11 +24,11 @@ Represents a panel that lays out cells and column headers in a data grid. - is used as the of the to lay out cells in a row. It is used as the of the to lay out column headers. The panel arranges cells horizontally and uses each cell's column information to determine the correct size for each cell. - + is used as the of the to lay out cells in a row. It is used as the of the to lay out column headers. The panel arranges cells horizontally and uses each cell's column information to determine the correct size for each cell. + ]]> @@ -87,11 +87,11 @@ Determines the final size and placement of the panel. The final size and placement of the panel. - class uses the method to lay out the cells that are visible. Cells that are not visible are virtualized. - + class uses the method to lay out the cells that are visible. Cells that are not visible are virtualized. + ]]> @@ -161,11 +161,11 @@ Determines the desired size of the panel. The desired size of the panel. - class uses the method to determine which cells are visible and which cells are virtualized. - + class uses the method to determine which cells are visible and which cells are virtualized. + ]]> @@ -268,13 +268,13 @@ The data for the event. Updates the visible cells when an item in the collection has changed. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> diff --git a/xml/System.Windows.Controls/DataGridCheckBoxColumn.xml b/xml/System.Windows.Controls/DataGridCheckBoxColumn.xml index d4169cfce88..c597b7bf7b8 100644 --- a/xml/System.Windows.Controls/DataGridCheckBoxColumn.xml +++ b/xml/System.Windows.Controls/DataGridCheckBoxColumn.xml @@ -31,9 +31,9 @@ ![A DataGridCheckBox column](~/add/media/wpf-datagrid-checkbox.png "A DataGridCheckBox column") - To populate the column, bind the column to the data by using the property. The property is applied to the element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if your data source and target are different types. For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). + To populate the column, bind the column to the data by using the property. The property is applied to the element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if your data source and target are different types. For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). - You can customize the by setting properties, such as , , , and . + You can customize the by setting properties, such as , , , and . If you want to display other types of data, provides the following column types: @@ -324,7 +324,7 @@ control calls the method when a cell in a column derived from enters editing mode. The class overrides this method to respond immediately to the user gesture by updating the value in the hosted control. This immediate response is necessary because a cell enters edit mode with the same user gesture that changes the state of its hosted . + The control calls the method when a cell in a column derived from enters editing mode. The class overrides this method to respond immediately to the user gesture by updating the value in the hosted control. This immediate response is necessary because a cell enters edit mode with the same user gesture that changes the state of its hosted . ]]> diff --git a/xml/System.Windows.Controls/DataGridClipboardCellContent.xml b/xml/System.Windows.Controls/DataGridClipboardCellContent.xml index 4376683b573..dacb8c6e7fa 100644 --- a/xml/System.Windows.Controls/DataGridClipboardCellContent.xml +++ b/xml/System.Windows.Controls/DataGridClipboardCellContent.xml @@ -211,7 +211,7 @@ , , and property values. + The hash code is based on the , , and property values. ]]> diff --git a/xml/System.Windows.Controls/DataGridColumn.xml b/xml/System.Windows.Controls/DataGridColumn.xml index 5ac1a4ecb7e..c4d45902ad8 100644 --- a/xml/System.Windows.Controls/DataGridColumn.xml +++ b/xml/System.Windows.Controls/DataGridColumn.xml @@ -92,9 +92,9 @@ property is used to arrange the cells and header of the column. The value is coerced to be within the and constraints. + The value of the property is used to arrange the cells and header of the column. The value is coerced to be within the and constraints. - To get the rendered width of the column, use the of the property. + To get the rendered width of the column, use the of the property. ]]> @@ -384,7 +384,7 @@ for a cell, specify a of . + To define a for a cell, specify a of . A can be applied to a cell at the table, column, or cell level. To apply a to all cells in a column, set the property, which takes precedence over the property. To apply a to an individual cell, set the property directly on the object, which takes precedence over all other styles that you apply to the cell. @@ -593,11 +593,11 @@ property has a default value of -1 before it is added to the collection. This value is updated when the column is added to the . + The property has a default value of -1 before it is added to the collection. This value is updated when the column is added to the . - The requires that the property of each column must be a unique integer from 0 to the of -1. Therefore, when the of one column changes, the change typically causes the of other columns to also change. + The requires that the property of each column must be a unique integer from 0 to the of -1. Therefore, when the of one column changes, the change typically causes the of other columns to also change. - The restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. + The restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. When the value of the property is changed, the event is raised. @@ -662,9 +662,9 @@ for an individual column in the . To define a for the drag indicator, specify a of . + Use this property to set the for an individual column in the . To define a for the drag indicator, specify a of . - You can set properties in the style to change the appearance of certain elements of the drag indicator, such as the border around the column header. However, the default template for the drag indicator uses a to paint a with an image of the original column header that is being dragged. As a result, if you set some properties in your style, such as or , they will appear to not be applied. To change the appearance of the column header while it is being dragged, apply a new template that does not use the default . + You can set properties in the style to change the appearance of certain elements of the drag indicator, such as the border around the column header. However, the default template for the drag indicator uses a to paint a with an image of the original column header that is being dragged. As a result, if you set some properties in your style, such as or , they will appear to not be applied. To change the appearance of the column header while it is being dragged, apply a new template that does not use the default . ]]> @@ -1000,14 +1000,14 @@ for a column header, specify a of . + To define a for a column header, specify a of . A can be applied to all column headers or to an individual column header. To apply a to an individual header, set the property, which takes precedence over the property. ## Examples - The following example uses a style resource to change the style of column headers in the . The style of the first column header is then set with an inline style that overrides the . + The following example uses a style resource to change the style of column headers in the . The style of the first column header is then set with an inline style that overrides the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGrid/ColumnHeaderStyle/mainwindow.xaml" id="Snippet1"::: @@ -1241,7 +1241,7 @@ cannot be used to freeze a column. Instead, set the property. The leftmost columns up to the column that is specified by the number will freeze in place. + cannot be used to freeze a column. Instead, set the property. The leftmost columns up to the column that is specified by the number will freeze in place. @@ -1386,15 +1386,15 @@ is not a valid value for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - The of the and properties are constrained by the following properties, if they are set, in order of precedence: + The of the and properties are constrained by the following properties, if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> @@ -1463,15 +1463,15 @@ and are not valid values for this property. The value restrictions on the value are enforced by a mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown. - The of the and properties are constrained by the following properties, if they are set, in order of precedence: + The of the and properties are constrained by the following properties, if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> @@ -1983,15 +1983,15 @@ ## Remarks The property, when set on an individual , takes precedence over the property. - The of the property is constrained by the following properties, if they are set, in order of precedence: + The of the property is constrained by the following properties, if they are set, in order of precedence: -- +- -- +- -- +- -- +- ]]> diff --git a/xml/System.Windows.Controls/DataGridComboBoxColumn.xml b/xml/System.Windows.Controls/DataGridComboBoxColumn.xml index 477f944b3de..d6c013b05e7 100644 --- a/xml/System.Windows.Controls/DataGridComboBoxColumn.xml +++ b/xml/System.Windows.Controls/DataGridComboBoxColumn.xml @@ -39,13 +39,13 @@ - An inline collection of types. - Once the is set, bind the selected item in the to the data item for the row that the cell is in. You can set the binding by using one of the following properties: + Once the is set, bind the selected item in the to the data item for the row that the cell is in. You can set the binding by using one of the following properties: |Property|Description| |--------------|-----------------| -||Sets the binding path of the text for the currently selected item.| -||Sets the binding path of the object that is currently selected.| -||Sets the binding path to the value of the selected item specified by the property.| +||Sets the binding path of the text for the currently selected item.| +||Sets the binding path of the object that is currently selected.| +||Sets the binding path to the value of the selected item specified by the property.| When the property is set to `true`, users cannot edit the column and they will not be able to see the drop-down list. @@ -239,9 +239,9 @@ . + This style is the same as the . - If you are creating new styles for cells and you want to inherit some of the existing style elements, base the new style on by using the property. + If you are creating new styles for cells and you want to inherit some of the existing style elements, base the new style on by using the property. ]]> @@ -276,7 +276,7 @@ by using the property. + If you are creating new styles and you want to inherit some of the existing style elements, base the new style on by using the property. ]]> @@ -311,7 +311,7 @@ property is equivalent to setting the of the property binding in a template. The following template shows an example of the equivalent setting. + Use this property to define a simple template that describes how to display the data objects. Setting the property is equivalent to setting the of the property binding in a template. The following template shows an example of the equivalent setting. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGridComboBoxColumn/DisplayMemberPath/window1.xaml" id="Snippet1"::: @@ -376,7 +376,7 @@ by getting the . + You can reset the default by getting the . ]]> @@ -438,7 +438,7 @@ by getting the . + You can reset the default by getting the . ]]> diff --git a/xml/System.Windows.Controls/DataGridEditAction.xml b/xml/System.Windows.Controls/DataGridEditAction.xml index 58b7f75e634..f0d55a5f1fb 100644 --- a/xml/System.Windows.Controls/DataGridEditAction.xml +++ b/xml/System.Windows.Controls/DataGridEditAction.xml @@ -22,11 +22,11 @@ Defines constants that specify whether an edit is being canceled or committed. - and properties. - + and properties. + ]]> diff --git a/xml/System.Windows.Controls/DataGridEditingUnit.xml b/xml/System.Windows.Controls/DataGridEditingUnit.xml index 5e367aa65a5..12f9995c478 100644 --- a/xml/System.Windows.Controls/DataGridEditingUnit.xml +++ b/xml/System.Windows.Controls/DataGridEditingUnit.xml @@ -22,11 +22,11 @@ Defines constants that specify whether editing is enabled on a cell level or on a row level. - and methods. - + and methods. + ]]> diff --git a/xml/System.Windows.Controls/DataGridGridLinesVisibility.xml b/xml/System.Windows.Controls/DataGridGridLinesVisibility.xml index 04c70f442c2..477aef6e8b4 100644 --- a/xml/System.Windows.Controls/DataGridGridLinesVisibility.xml +++ b/xml/System.Windows.Controls/DataGridGridLinesVisibility.xml @@ -27,7 +27,7 @@ ## Remarks This enumeration is used by the property. - The style of the grid lines is determined by the and properties. + The style of the grid lines is determined by the and properties. ]]> diff --git a/xml/System.Windows.Controls/DataGridHeadersVisibility.xml b/xml/System.Windows.Controls/DataGridHeadersVisibility.xml index b4209c51a82..8bcaa0a3f6c 100644 --- a/xml/System.Windows.Controls/DataGridHeadersVisibility.xml +++ b/xml/System.Windows.Controls/DataGridHeadersVisibility.xml @@ -33,7 +33,7 @@ ## Remarks This enumeration is used by the property. - The style of the headers is determined by the and properties. + The style of the headers is determined by the and properties. ]]> diff --git a/xml/System.Windows.Controls/DataGridHyperlinkColumn.xml b/xml/System.Windows.Controls/DataGridHyperlinkColumn.xml index 27333acd62b..1e21f83810e 100644 --- a/xml/System.Windows.Controls/DataGridHyperlinkColumn.xml +++ b/xml/System.Windows.Controls/DataGridHyperlinkColumn.xml @@ -36,7 +36,7 @@ > > For more information about XBAP support, see [Frequently asked questions about WPF browser-hosted applications (XBAP)](/dotnet/desktop/wpf/app-development/xbap-faq?view=netframeworkdesktop-4.8). - To populate the column, bind the column to the data by using the property. To display hyperlink text that is different than the URI string, bind the text value to the property. The property is applied to the or element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if you want to convert the data. For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). + To populate the column, bind the column to the data by using the property. To display hyperlink text that is different than the URI string, bind the text value to the property. The property is applied to the or element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if you want to convert the data. For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). > [!NOTE] > creates a element in the non-editing mode and a element in the editing mode. diff --git a/xml/System.Windows.Controls/DataGridRow.xml b/xml/System.Windows.Controls/DataGridRow.xml index 3db7ba8f0db..ed17e3d2967 100644 --- a/xml/System.Windows.Controls/DataGridRow.xml +++ b/xml/System.Windows.Controls/DataGridRow.xml @@ -88,9 +88,9 @@ property of the to indicate the number of rows within a set of alternating rows. For more information about alternating rows, see . + Alternating rows are rows to which you can assign different characteristics, such as alternating background colors. You can set the property of the to indicate the number of rows within a set of alternating rows. For more information about alternating rows, see . - Override the method to respond to changes to the property. The property does not have its own property changed method because the field reuses the read-only field. + Override the method to respond to changes to the property. The property does not have its own property changed method because the field reuses the read-only field. ]]> @@ -491,7 +491,7 @@ for a row header, specify a of . + To define a for a row header, specify a of . A can be applied to all row headers, or to an individual row header. To apply a to an individual header set the property, which takes precedence over the property. @@ -1124,7 +1124,7 @@ . The specific dependency property that changed is reported in the arguments parameter. + This method overrides . The specific dependency property that changed is reported in the arguments parameter. Override this method to respond to changes to the property. The property does not have its own property changed method because the field reuses the read-only field. @@ -1172,7 +1172,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -1253,7 +1253,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> diff --git a/xml/System.Windows.Controls/DataGridSelectionMode.xml b/xml/System.Windows.Controls/DataGridSelectionMode.xml index fad091a7dd1..c78d22ea34f 100644 --- a/xml/System.Windows.Controls/DataGridSelectionMode.xml +++ b/xml/System.Windows.Controls/DataGridSelectionMode.xml @@ -22,13 +22,13 @@ Defines constants that specify whether single or multiple item selections are supported by a control. - and properties together determine how users can select items in a . For example, if the is `Single` and the is , the user can select one cell at a time in the . - - In `Extended` mode, select multiple items by holding down the SHIFT key to extend the selection from an anchor point or the CTRL key to individually select additional items. - + and properties together determine how users can select items in a . For example, if the is `Single` and the is , the user can select one cell at a time in the . + + In `Extended` mode, select multiple items by holding down the SHIFT key to extend the selection from an anchor point or the CTRL key to individually select additional items. + ]]> diff --git a/xml/System.Windows.Controls/DataGridSelectionUnit.xml b/xml/System.Windows.Controls/DataGridSelectionUnit.xml index 701f838d569..a0b04eeb788 100644 --- a/xml/System.Windows.Controls/DataGridSelectionUnit.xml +++ b/xml/System.Windows.Controls/DataGridSelectionUnit.xml @@ -22,11 +22,11 @@ Defines constants that specify whether cells, rows, or both, are used for selection in a control. - and properties together determine how users can select items in a . For example, if the is and the is `Cell`, the user can select only one cell at a time in the . - + and properties together determine how users can select items in a . For example, if the is and the is `Cell`, the user can select only one cell at a time in the . + ]]> diff --git a/xml/System.Windows.Controls/DataGridTemplateColumn.xml b/xml/System.Windows.Controls/DataGridTemplateColumn.xml index cfd1e12d042..8490b7b103c 100644 --- a/xml/System.Windows.Controls/DataGridTemplateColumn.xml +++ b/xml/System.Windows.Controls/DataGridTemplateColumn.xml @@ -115,12 +115,12 @@ ## Remarks The cell editing template defines how the content is displayed in the column cells when in editing mode. For more information about data templates, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview) and [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). - To define the template for the cell that is not in editing mode, use the . + To define the template for the cell that is not in editing mode, use the . ## Examples - The following example shows how to create the for displaying and editing a column of dates. + The following example shows how to create the for displaying and editing a column of dates. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGridTemplateColumn/Overview/window1.xaml" id="Snippet1"::: @@ -246,12 +246,12 @@ ## Remarks The cell template defines how the content is displayed in the column cells. For more information about data templates, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview) and [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). - To define the template for a cell that is in editing mode, use the . + To define the template for a cell that is in editing mode, use the . ## Examples - The following example shows how to create the for displaying a column of dates. + The following example shows how to create the for displaying a column of dates. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/DataGridTemplateColumn/Overview/window1.xaml" id="Snippet1"::: diff --git a/xml/System.Windows.Controls/DataGridTextColumn.xml b/xml/System.Windows.Controls/DataGridTextColumn.xml index 4ea31d3dcab..56361939834 100644 --- a/xml/System.Windows.Controls/DataGridTextColumn.xml +++ b/xml/System.Windows.Controls/DataGridTextColumn.xml @@ -31,11 +31,11 @@ ![Two DataGridTextColumns](~/add/media/wpf-datagridtextcolumns.png "Two DataGridTextColumns") - To create a column, add it to the collection. To populate the column, bind the column to the data by using the property. The property is applied to the or element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if you want to convert the data or the . For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). + To create a column, add it to the collection. To populate the column, bind the column to the data by using the property. The property is applied to the or element created in the column. The for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the . Optionally, you can specify a if you want to convert the data or the . For more information about data binding, see [Data Binding (WPF)](/dotnet/framework/wpf/data/data-binding-wpf). **Note** creates a element in the non-editing mode and a element in the editing mode. - You can customize the by setting properties, such as , , , and . + You can customize the by setting properties, such as , , , and . If you want to display other types of data, provides the following column types: diff --git a/xml/System.Windows.Controls/DataTemplateSelector.xml b/xml/System.Windows.Controls/DataTemplateSelector.xml index 775e6c684ba..a60c8d7baba 100644 --- a/xml/System.Windows.Controls/DataTemplateSelector.xml +++ b/xml/System.Windows.Controls/DataTemplateSelector.xml @@ -29,14 +29,14 @@ ## Remarks Typically, you create a when you have more than one for the same type of objects and you want to supply your own logic to choose a to apply based on the properties of each data object. Note that if you have objects of different types you can set the property on the . If you do that then there is no need to create a . Furthermore, if you have objects of the same type but with different properties, you can also consider using a or a data converter. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - To create a template selector, create a class that inherits from and override the method. Once your class is defined you can assign an instance of the class to the template selector property of your element. + To create a template selector, create a class that inherits from and override the method. Once your class is defined you can assign an instance of the class to the template selector property of your element. ## Examples In this example, the binding source is a list of `Task` objects. One of the properties of a `Task` object is `Priority`. There are two data templates defined, `myTaskTemplate` and `importantTaskTemplate`. - To supply logic to choose which to use based on the `Priority` value of the data object, create a subclass of and override the method. In the following example, the method provides logic to return the appropriate template based on the value of the `Priority` property. The template to return is found in the resources of the enveloping element. + To supply logic to choose which to use based on the `Priority` value of the data object, create a subclass of and override the method. In the following example, the method provides logic to return the appropriate template based on the value of the `Priority` property. The template to return is found in the resources of the enveloping element. :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/TaskListDataTemplateSelector.cs" id="Snippetdtsclass"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/DataTemplateSelector/Overview/tasklistdatatemplateselector.vb" id="Snippetdtsclass"::: @@ -47,7 +47,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetdts"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetr2"::: - To use the template selector resource, assign it to the property of the . The calls the method of the `TaskListDataTemplateSelector` for each of the items in the underlying collection. The call passes the data object as the item parameter. The that is returned by the method is then applied to that data object. + To use the template selector resource, assign it to the property of the . The calls the method of the `TaskListDataTemplateSelector` for each of the items in the underlying collection. The call passes the data object as the item parameter. The that is returned by the method is then applied to that data object. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetitemtemplateselector"::: @@ -124,14 +124,14 @@ and overriding the method. Once your class is defined you can assign an instance of the class to the template selector property of your element. + Typically, you use a template selector when you have more than one data template defined for the same type of objects. For example, if your binding source is list a list of student objects and you want to apply a particular template to the part-time students. You can do this by creating a class that inherits from and overriding the method. Once your class is defined you can assign an instance of the class to the template selector property of your element. ## Examples In this example, the binding source is a list of `Task` objects. One of the properties of a `Task` object is `Priority`. There are two data templates defined, `myTaskTemplate` and `importantTaskTemplate`. - To supply logic to choose which to use based on the `Priority` value of the data object, create a subclass of and override the method. In the following example, the method provides logic to return the appropriate template based on the value of the `Priority` property. The template to return is found in the resources of the enveloping element. + To supply logic to choose which to use based on the `Priority` value of the data object, create a subclass of and override the method. In the following example, the method provides logic to return the appropriate template based on the value of the `Priority` property. The template to return is found in the resources of the enveloping element. :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/TaskListDataTemplateSelector.cs" id="Snippetdtsclass"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/DataTemplateSelector/Overview/tasklistdatatemplateselector.vb" id="Snippetdtsclass"::: @@ -142,7 +142,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetdts"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetr2"::: - To use the template selector resource, assign it to the property of the . The calls the method of the `TaskListDataTemplateSelector` for each of the items in the underlying collection. The call passes the data object as the item parameter. The that is returned by the method is then applied to that data object. + To use the template selector resource, assign it to the property of the . The calls the method of the `TaskListDataTemplateSelector` for each of the items in the underlying collection. The call passes the data object as the item parameter. The that is returned by the method is then applied to that data object. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Overview/Window1.xaml" id="Snippetitemtemplateselector"::: diff --git a/xml/System.Windows.Controls/DatePicker.xml b/xml/System.Windows.Controls/DatePicker.xml index 34d83726026..1859c55a240 100644 --- a/xml/System.Windows.Controls/DatePicker.xml +++ b/xml/System.Windows.Controls/DatePicker.xml @@ -47,7 +47,7 @@ ## Remarks The control allows the user to select a date by either typing it into a text field or by using a drop-down control. - Many of a control's properties are for managing its built-in , and function identically to the equivalent property in . In particular, the , , , , , , and properties function identically to their counterparts. For more information, see . + Many of a control's properties are for managing its built-in , and function identically to the equivalent property in . In particular, the , , , , , , and properties function identically to their counterparts. For more information, see . Users can type a date directly into a text field, which sets the property. If the cannot convert the entered string to a valid date, the event will be raised. By default, this causes an exception, but an event handler for can set the property to `false` and prevent an exception from being raised. @@ -147,9 +147,9 @@ DatePicker Control ## Remarks Dates in this collection will appear as disabled on the drop-down calendar. If the user types a date that is not selectable, the event occurs. - To make all past dates not selectable, you can use the method provided by the collection returned by this property. + To make all past dates not selectable, you can use the method provided by the collection returned by this property. - Adding a date to this collection when it is already selected or adding a date outside the range specified by and will cause an . + Adding a date to this collection when it is already selected or adding a date outside the range specified by and will cause an . ## XAML Property Element Usage @@ -482,9 +482,9 @@ DatePicker with dates that are not selectable | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| - This property allows the developer to specify a date to display if is `null`. + This property allows the developer to specify a date to display if is `null`. ## XAML Attribute Usage @@ -548,7 +548,7 @@ DatePicker with dates that are not selectable | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -667,7 +667,7 @@ DatePicker with dates that are not selectable | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -871,7 +871,7 @@ DatePicker with dates that are not selectable | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| Setting this property will cause the drop-down to open or close. @@ -1035,7 +1035,7 @@ DatePicker with dates that are not selectable method. + This method is invoked whenever application code or an internal process, such as rebuilding layout pass, calls the method. ]]> @@ -1211,7 +1211,7 @@ DatePicker with dates that are not selectable event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1257,7 +1257,7 @@ DatePicker with dates that are not selectable | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## XAML Attribute Usage @@ -1490,9 +1490,9 @@ DatePicker with dates that are not selectable of a by typing a date into its text box. The attempts to parse any string entered into this property as a date. While the property can be set to any string that can be parsed by the method date, the format of the string that is returned depends on the value of the property. This means that the might display a string that is different than what the user typed. + A user can set the of a by typing a date into its text box. The attempts to parse any string entered into this property as a date. While the property can be set to any string that can be parsed by the method date, the format of the string that is returned depends on the value of the property. This means that the might display a string that is different than what the user typed. - If is set to a date that is selectable and valid, the event occurs. If you handle the event and set the property to `true`, a or is raised. + If is set to a date that is selectable and valid, the event occurs. If you handle the event and set the property to `true`, a or is raised. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/DatePickerDateValidationErrorEventArgs.xml b/xml/System.Windows.Controls/DatePickerDateValidationErrorEventArgs.xml index f2e0d26a119..5c142b641f2 100644 --- a/xml/System.Windows.Controls/DatePickerDateValidationErrorEventArgs.xml +++ b/xml/System.Windows.Controls/DatePickerDateValidationErrorEventArgs.xml @@ -26,14 +26,14 @@ event occurs when is set to a value that cannot be interpreted as a date or when the date cannot be selected. You can subscribe to this event and specify whether an exception is raised by setting the property. If is `true`, one of the following exceptions is raised: + The event occurs when is set to a value that cannot be interpreted as a date or when the date cannot be selected. You can subscribe to this event and specify whether an exception is raised by setting the property. If is `true`, one of the following exceptions is raised: |Exception type|Condition| |--------------------|---------------| ||The text entered cannot be parsed to a valid date, and the exception is not suppressed.| ||The text entered parses to a date that is not selectable.| - If is `false`, the application continues execution as usual. + If is `false`, the application continues execution as usual. diff --git a/xml/System.Windows.Controls/Decorator.xml b/xml/System.Windows.Controls/Decorator.xml index e500b2c01a7..ad713876b67 100644 --- a/xml/System.Windows.Controls/Decorator.xml +++ b/xml/System.Windows.Controls/Decorator.xml @@ -208,7 +208,7 @@ Border around a TextBox can equal only 0 or 1, specifying an `index` position greater than 1 or less than 0 results in an . + Because can equal only 0 or 1, specifying an `index` position greater than 1 or less than 0 results in an . ]]> diff --git a/xml/System.Windows.Controls/DefinitionBase.xml b/xml/System.Windows.Controls/DefinitionBase.xml index 9e59a43c4da..5054df5a684 100644 --- a/xml/System.Windows.Controls/DefinitionBase.xml +++ b/xml/System.Windows.Controls/DefinitionBase.xml @@ -68,7 +68,7 @@ ## Remarks Columns and rows that participate in size-sharing do not respect sizing. In the size-sharing scenario, sizing is treated as . - size-sharing does not work if you set to `true` within a resource template and you define as outside that template. + size-sharing does not work if you set to `true` within a resource template and you define as outside that template. The property value must satisfy the following rules: @@ -84,7 +84,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls/DockPanel.xml b/xml/System.Windows.Controls/DockPanel.xml index b2956435a3f..eb05dd19ab1 100644 --- a/xml/System.Windows.Controls/DockPanel.xml +++ b/xml/System.Windows.Controls/DockPanel.xml @@ -30,7 +30,7 @@ ## Remarks A contains a collection of objects, which are in the property. - The method changes the position of an element relative to other elements within the same container. Alignment properties, such as , change the position of an element relative to its parent element. + The method changes the position of an element relative to other elements within the same container. Alignment properties, such as , change the position of an element relative to its parent element. If you set the property to `true`, which is the default setting, the last child element of a always fills the remaining space, regardless of any other dock value that you set on the last child element. To dock a child element in another direction, you must set the property to `false` and must also specify an explicit dock direction for the last child element. @@ -151,7 +151,7 @@ ## Examples - The following example shows how to set the attached property by using Extensible Application Markup Language (XAML). + The following example shows how to set the attached property by using Extensible Application Markup Language (XAML). :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/DockPanelOvwSample/CPP/DockPanel_Ovw_Sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/DockPanel/Dock/DockPanel_Ovw_Sample.cs" id="Snippet1"::: @@ -273,7 +273,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -383,7 +383,7 @@ method changes the position of a child element relative to other child elements within the same container. Alignment properties, such as , change the position of a child element relative to its parent element. + The method changes the position of a child element relative to other child elements within the same container. Alignment properties, such as , change the position of a child element relative to its parent element. ]]> diff --git a/xml/System.Windows.Controls/DocumentViewer.xml b/xml/System.Windows.Controls/DocumentViewer.xml index 7fb3234022f..721a25553e8 100644 --- a/xml/System.Windows.Controls/DocumentViewer.xml +++ b/xml/System.Windows.Controls/DocumentViewer.xml @@ -189,7 +189,7 @@ becomes `false` when the maximum zoom level is reached. + The maximum zoom value is 5000%. becomes `false` when the maximum zoom level is reached. ## Dependency Property Information @@ -605,7 +605,7 @@ `800%` - The minimum zoom level is 5%. After the minimum zoom level is reached, has no more effect. + The minimum zoom level is 5%. After the minimum zoom level is reached, has no more effect. The property returns `false` when the minimum zoom level is reached. @@ -648,7 +648,7 @@ is the sum of all the page heights and includes the space between pages. + For vertical page arrangements, is the sum of all the page heights and includes the space between pages. ## Dependency Property Information @@ -726,7 +726,7 @@ is the sum of all the page widths and includes the space between pages. + For horizontal page arrangements, is the sum of all the page widths and includes the space between pages. ## Dependency Property Information @@ -1080,7 +1080,7 @@ sets the control to display a single page width with pages zoomed to the width of the current viewport. + sets the control to display a single page width with pages zoomed to the width of the current viewport. ]]> @@ -1164,7 +1164,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1337,7 +1337,7 @@ `800%` - The maximum zoom value is 5000%. After the maximum zoom level is reached, has no more effect. + The maximum zoom value is 5000%. After the maximum zoom level is reached, has no more effect. The property returns `false` when the maximum zoom level is reached. @@ -1381,7 +1381,7 @@ can be set to a positive integer value from 1 to 32, inclusive. + can be set to a positive integer value from 1 to 32, inclusive. ## Dependency Property Information @@ -1389,7 +1389,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1757,7 +1757,7 @@ responds to calls when the property of the control is set to display a new document. + responds to calls when the property of the control is set to display a new document. ]]> @@ -2704,7 +2704,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2771,7 +2771,7 @@ must be set with non-negative offset values. Setting a negative value raises an exception. + must be set with non-negative offset values. Setting a negative value raises an exception. The vertical offset is measured from the top of the visible content area. @@ -2783,7 +2783,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2855,7 +2855,7 @@ ## Remarks Setting the property adjusts the vertical spacing between pages to the specified value. - The value must be non-negative. Setting this property to a negative value will raise an exception. + The value must be non-negative. Setting this property to a negative value will raise an exception. When setting this property in XAML, you cannot use the unit qualifiers (such as `in` or `cm`) that are enabled for many other "Height" or "Vertical" properties. @@ -3126,7 +3126,7 @@ sizes and arranges the view to display a thumbnail preview of each page. + sizes and arranges the view to display a thumbnail preview of each page. The following table shows the keyboard shortcut key associated with this command. @@ -3175,7 +3175,7 @@ The property must be a value between 5.0 to 5000.0 (inclusive), which corresponds to a percentage range 5.0% to 5000.0%. - Actions or commands that require a layout update may change the property setting. For example, changing the value of , calling the method, or invoking the can cause the setting to change. + Actions or commands that require a layout update may change the property setting. For example, changing the value of , calling the method, or invoking the can cause the setting to change. ## Dependency Property Information @@ -3183,7 +3183,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls/ExceptionValidationRule.xml b/xml/System.Windows.Controls/ExceptionValidationRule.xml index 2ef0b2ee0ef..a67aa6781b7 100644 --- a/xml/System.Windows.Controls/ExceptionValidationRule.xml +++ b/xml/System.Windows.Controls/ExceptionValidationRule.xml @@ -27,7 +27,7 @@ with a object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . + The WPF data binding model enables you to associate with a object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . An alternative syntax to setting the explicitly is to set the property to `true` on your or object. @@ -36,11 +36,11 @@ ## Examples - The property takes a collection of objects. The following example uses as the binding target property and `StartPrice` (an integer) as the binding source property. When the user enters a value that cannot be converted to an integer, an exception is thrown, which causes the to invalidate the target value. + The property takes a collection of objects. The following example uses as the binding target property and `StartPrice` (an integer) as the binding source property. When the user enters a value that cannot be converted to an integer, an exception is thrown, which causes the to invalidate the target value. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetdefaultvalidation"::: - By default, when there is a validation error, the appears with a red border. Optionally, you can write a custom to specify how you want to notify the user when there is a validation error. + By default, when there is a validation error, the appears with a red border. Optionally, you can write a custom to specify how you want to notify the user when there is a validation error. For more information about data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). diff --git a/xml/System.Windows.Controls/Expander.xml b/xml/System.Windows.Controls/Expander.xml index f0c1856309e..72b5cc5a146 100644 --- a/xml/System.Windows.Controls/Expander.xml +++ b/xml/System.Windows.Controls/Expander.xml @@ -34,7 +34,7 @@ is a , which means its and properties can be of any type (such as string, image, or panel). For more information, see the class. + is a , which means its and properties can be of any type (such as string, image, or panel). For more information, see the class. The following illustration shows an control. @@ -42,11 +42,11 @@ If the content of the expanded window is too large for the window, you can wrap the content of the in a control to provide scrollable content. Scrolling capability is not automatically provided by the control. - For an to work correctly, do not specify a on the control when the property is set to or . Similarly, do not specify a on the control when the property is set to or . When you set a size on the control in the direction that the expanded content is displayed, the area that is defined by the size parameter is displayed with a border around it. This area displays even when the window is collapsed. To set the size of the expanded window, set size dimensions on the content of the control or the that encloses the content. + For an to work correctly, do not specify a on the control when the property is set to or . Similarly, do not specify a on the control when the property is set to or . When you set a size on the control in the direction that the expanded content is displayed, the area that is defined by the size parameter is displayed with a border around it. This area displays even when the window is collapsed. To set the size of the expanded window, set size dimensions on the content of the control or the that encloses the content. When an control is the last element in a , the is sized to fill the remaining area of the . To prevent this, set the property on the to `false`, or make sure that the is not the last element in a . - The alignment of content can be defined by setting the and properties on the control. These properties are applied to the header and to the contents of the expanded window. + The alignment of content can be defined by setting the and properties on the control. These properties are applied to the header and to the contents of the expanded window. ## Customizing the Expander Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [Expander Styles and Templates](/dotnet/framework/wpf/controls/expander-styles-and-templates). @@ -231,7 +231,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -410,7 +410,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Controls/FlowDocumentPageViewer.xml b/xml/System.Windows.Controls/FlowDocumentPageViewer.xml index 34598df48e1..92ffe85a13b 100644 --- a/xml/System.Windows.Controls/FlowDocumentPageViewer.xml +++ b/xml/System.Windows.Controls/FlowDocumentPageViewer.xml @@ -48,9 +48,9 @@ - **Page Navigation Controls** - The page navigation controls include a button to jump to the next page (the down arrow) or previous page (the up arrow), as well as indicators for the current page number and total number of pages. - - **Zoom Controls** - The zoom controls enable the user to increase or decrease the zoom level by clicking the plus or minus buttons, respectively. The zoom controls also include a slider for adjusting the zoom level. For more information, see . + - **Zoom Controls** - The zoom controls enable the user to increase or decrease the zoom level by clicking the plus or minus buttons, respectively. The zoom controls also include a slider for adjusting the zoom level. For more information, see . - - **Search** - The user can use the Ctr+F keyboard shortcut or you can use to toggle a search textbox that is used to find strings within the content. See for more information. + - **Search** - The user can use the Ctr+F keyboard shortcut or you can use to toggle a search textbox that is used to find strings within the content. See for more information. @@ -119,7 +119,7 @@ method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -195,7 +195,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -232,7 +232,7 @@ method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -307,7 +307,7 @@ , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. + If you derive from , you need this key in order to set the value of the dependency property. Call , passing as the `key` parameter. ]]> @@ -349,7 +349,7 @@ level by the value specified by the property. + This method decreases the current level by the value specified by the property. Default user interface (UI) includes a button to decrease the zoom. @@ -456,7 +456,7 @@ level by the value specified by the property. + This method increases the current level by the value specified by the property. Default user interface (UI) includes a button to increase the zoom. @@ -644,7 +644,7 @@ user interface (UI) includes a slider that can be used to adjust the level. This property specifies the upper-limit value for the slider. + The default user interface (UI) includes a slider that can be used to adjust the level. This property specifies the upper-limit value for the slider. ## Dependency Property Information @@ -732,7 +732,7 @@ user interface (UI) includes a slider that can be used to adjust the level. This property specifies the lower-limit value for the slider. + The default user interface (UI) includes a slider that can be used to adjust the level. This property specifies the lower-limit value for the slider. ## Dependency Property Information @@ -820,9 +820,9 @@ is called. + This method is called whenever is called. - This method overrides . + This method overrides . ]]> @@ -858,7 +858,7 @@ command is called. + This method is called when the command is called. ]]> @@ -965,7 +965,7 @@ command is called. + This method is called when the command is called. ]]> @@ -1001,7 +1001,7 @@ . + This method overrides . ]]> @@ -1037,7 +1037,7 @@ command is called. + This method is called when the command is called. ]]> @@ -1073,9 +1073,9 @@ command is called. + This method is called when the command is called. - This method overrides . + This method overrides . ]]> @@ -1114,9 +1114,9 @@ command is called. + This method is called when the command is called. - This method overrides . + This method overrides . ]]> @@ -1152,7 +1152,7 @@ command is called. + This method is called when the command is called. ]]> @@ -1201,7 +1201,7 @@ . + This method overrides . ]]> @@ -1237,9 +1237,9 @@ command is called. + This method is called when the command is called. - This method overrides . + This method overrides . ]]> @@ -1280,7 +1280,7 @@ ## Remarks This method is called whenever the routed event is raised. - This method overrides . + This method overrides . ]]> @@ -1316,9 +1316,9 @@ command is called. + This method is called when the command is called. - This method overrides . + This method overrides . ]]> @@ -1356,7 +1356,7 @@ ## Remarks This method is called whenever the routed event is raised. - This method overrides . + This method overrides . ]]> @@ -1392,9 +1392,9 @@ command is called. + This method is called when the command is called. - This method overrides . + This method overrides . ]]> @@ -1430,7 +1430,7 @@ command is called. + This method is called when the command is called. ]]> @@ -1501,7 +1501,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1545,7 +1545,7 @@ by setting the and the properties.. + You can specify the brush that highlights selected text in a by setting the and the properties.. @@ -1614,7 +1614,7 @@ to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. + If you set the to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. @@ -1684,7 +1684,7 @@ and properties. + The zoom level is constrained by the values of the and properties. ## Dependency Property Information @@ -1742,7 +1742,7 @@ level is increased or decreased when the or commands are executed, respectively. + The zoom increment is the percentage by which the level is increased or decreased when the or commands are executed, respectively. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/FlowDocumentReader.xml b/xml/System.Windows.Controls/FlowDocumentReader.xml index 7599e47bcb0..86d96f84970 100644 --- a/xml/System.Windows.Controls/FlowDocumentReader.xml +++ b/xml/System.Windows.Controls/FlowDocumentReader.xml @@ -56,13 +56,13 @@ - **Tool Bar** - The default toolbar is docked underneath the content area. It hosts controls for searching content, navigating pages, selecting a viewing mode, and changing the zoom level. - - **Find Button** - The **Find** button brings up a Find dialog, which enables the user to search the contents of the for specified terms or phrases. The **Find** button is not shown if is `false`. For more information, see . + - **Find Button** - The **Find** button brings up a Find dialog, which enables the user to search the contents of the for specified terms or phrases. The **Find** button is not shown if is `false`. For more information, see . - **Page Navigation Controls** - The page navigation controls include a button to jump to the next page (the down arrow) or previous page (the up arrow), as well as indicators for the current page number and total number of pages. - - **Viewing Mode Buttons** - The viewing mode buttons enable the user to select from available viewing modes. For more information, see . + - **Viewing Mode Buttons** - The viewing mode buttons enable the user to select from available viewing modes. For more information, see . - - **Zoom Controls** - The zoom controls enable the user to increase or decrease the zoom level by clicking the plus or minus buttons, respectively. The zoom controls also include a slider for adjusting the zoom level. For more information, see . + - **Zoom Controls** - The zoom controls enable the user to increase or decrease the zoom level by clicking the plus or minus buttons, respectively. The zoom controls also include a slider for adjusting the zoom level. For more information, see . The default toolbar UI does not include a **Print** button. @@ -178,7 +178,7 @@ method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -335,7 +335,7 @@ + ]]> @@ -446,7 +446,7 @@ method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -530,7 +530,7 @@ method decreases the current level by the value specified by the property. + The method decreases the current level by the value specified by the property. Default user interface (UI) includes a button to decrease the zoom. @@ -709,7 +709,7 @@ method increases the current level by the value specified by the property. + The method increases the current level by the value specified by the property. Default user interface (UI) includes a button to increase the zoom. @@ -758,7 +758,7 @@ ![Screenshot with callouts: FlowDocumentReader](~/add/media/flowdocrdr-find.png "Screenshot with callouts: FlowDocumentReader") - When is `false`, the **Find** button does not appear on the UI. + When is `false`, the **Find** button does not appear on the UI. ## Dependency Property Information @@ -771,7 +771,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: @@ -1005,7 +1005,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: @@ -1333,7 +1333,7 @@ user interface (UI) includes a slider that can be used to adjust the level. This property specifies the upper-limit value for the slider. + The default user interface (UI) includes a slider that can be used to adjust the level. This property specifies the upper-limit value for the slider. ## Dependency Property Information @@ -1346,7 +1346,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: @@ -1423,7 +1423,7 @@ user interface (UI) includes a slider that can be used to adjust the level. This property specifies the lower-limit value for the slider. + The default user interface (UI) includes a slider that can be used to adjust the level. This property specifies the lower-limit value for the slider. ## Dependency Property Information @@ -1436,7 +1436,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: @@ -1513,9 +1513,9 @@ is called. + This method is invoked whenever is called. - This method overrides . + This method overrides . ]]> @@ -1551,7 +1551,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1588,7 +1588,7 @@ . + This method overrides . ]]> @@ -1624,7 +1624,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1693,7 +1693,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1729,7 +1729,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1770,7 +1770,7 @@ ## Remarks This method is called when the property is `true`. - This method overrides . + This method overrides . ]]> @@ -1811,7 +1811,7 @@ ## Remarks This method moves the focus to the content area of the . - This method is called whenever the dependency property changes. + This method is called whenever the dependency property changes. ]]> @@ -1860,7 +1860,7 @@ will not be invoked. + Keystrokes are handled by a dedicated input manager. Other programming features that rely on keystrokes such as input and command bindings will potentially handle the keystroke before it is exposed as a general keystroke. If these input system features mark the event handled, then will not be invoked. This method has no default implementation. Calling base() in your implementation is still recommended, in case an intermediate class in the inheritance implemented this method. You may call base() either before or after your special handling, depending on your requirements. @@ -1901,7 +1901,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1975,7 +1975,7 @@ routed command is invoked. + This method is called when the routed command is invoked. ]]> @@ -2011,7 +2011,7 @@ are dynamically organized into a set of display pages, the number of which is based on current display and layout characteristics. For example, resizing a or changing the level affects the number of display pages that the content is organized into. + Flow content does not have any inherent notion of a fixed number of pages; the contents of a are dynamically organized into a set of display pages, the number of which is based on current display and layout characteristics. For example, resizing a or changing the level affects the number of display pages that the content is organized into. When the is in the viewing mode, the page count and the current page number are always 1 (assuming any content has been loaded). @@ -2086,7 +2086,7 @@ are dynamically organized into a set of display pages, the number of which is based on current display and layout characteristics. For example, resizing a or changing the level affects the number of display pages that the content is organized into. + Flow content does not have any inherent notion of a fixed number of pages; the contents of a are dynamically organized into a set of display pages, the number of which is based on current display and layout characteristics. For example, resizing a or changing the level affects the number of display pages that the content is organized into. When the is in the viewing mode, the page count and the current page number are always 1 (assuming any content has been loaded). @@ -2211,7 +2211,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -2255,7 +2255,7 @@ by setting the and the properties. + You can specify the brush that highlights selected text in a by setting the and the properties. @@ -2324,7 +2324,7 @@ to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. + If you set the to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. @@ -2442,11 +2442,11 @@ ## Remarks The class has built-in handling for this command (as well as built-in handling for a number of application and navigation commands). For more information on commanding and command binding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - Rather than initiate this command, you can instead call on the relevant . The result is the same. + Rather than initiate this command, you can instead call on the relevant . The result is the same. The **Switch Viewing Mode** command can either be parameterless, in which case the viewing mode advances to the next available viewing mode in the enumeration sequence, or it can specify a viewing mode by naming the in the command parameters. If used to set a command property in XAML, the command must be parameterless. - You could also use or respond to this command in a derived class, using either the built-in handling or replacing it with handling of your own. is a callback that you can use to change the class handling, without requiring changes to command bindings in the template or in instances. + You could also use or respond to this command in a derived class, using either the built-in handling or replacing it with handling of your own. is a callback that you can use to change the class handling, without requiring changes to command bindings in the template or in instances. ## XAML Text Usage @@ -2612,7 +2612,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2683,7 +2683,7 @@ ![FlowDocumentReader content zoom](~/add/media/flowdocrdr-zoom.png "FlowDocumentReader content zoom") - The zoom level is constrained by the values of the and properties. + The zoom level is constrained by the values of the and properties. ## Dependency Property Information @@ -2696,7 +2696,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: @@ -2743,7 +2743,7 @@ level is increased or decreased when the or commands are executed, respectively. + The zoom increment is the percentage by which the level is increased or decreased when the or commands are executed, respectively. Default user interface (UI) includes a zoom control that provides buttons for increasing or decreasing the zoom, as well as a slider for adjusting the zoom level. The following figure shows the zoom controls on a with default UI. @@ -2760,7 +2760,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentreaderxaml"::: diff --git a/xml/System.Windows.Controls/FlowDocumentScrollViewer.xml b/xml/System.Windows.Controls/FlowDocumentScrollViewer.xml index db7bb448ac0..fc29944004a 100644 --- a/xml/System.Windows.Controls/FlowDocumentScrollViewer.xml +++ b/xml/System.Windows.Controls/FlowDocumentScrollViewer.xml @@ -167,7 +167,7 @@ method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method decreases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -246,7 +246,7 @@ method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. + Calling the method increases the level by the amount specified by the property. The value of this property is subject to the value of the property. ## Dependency Property Information @@ -330,7 +330,7 @@ method decreases the current level by the value specified by the property. + The method decreases the current level by the value specified by the property. Calling this method has no effect if the property returns `false`. @@ -492,12 +492,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -575,7 +575,7 @@ method increases the current level by the value specified by the property. + The method increases the current level by the value specified by the property. Calling this method has no effect if the property @@ -774,7 +774,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -863,7 +863,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -977,7 +977,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -1066,7 +1066,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -1143,9 +1143,9 @@ is called. + This method is invoked whenever is called. - This method overrides . + This method overrides . ]]> @@ -1181,7 +1181,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1259,7 +1259,7 @@ . + This method overrides . ]]> @@ -1295,7 +1295,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1331,7 +1331,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1367,7 +1367,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1416,7 +1416,7 @@ . + This method overrides . ]]> @@ -1457,7 +1457,7 @@ ## Remarks This method is called whenever the routed event fires. - This method overrides . + This method overrides . ]]> @@ -1493,7 +1493,7 @@ command is invoked. + This method is called when the command is invoked. ]]> @@ -1611,7 +1611,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -1655,7 +1655,7 @@ by setting the and properties. + You can specify the brush that highlights selected text in a by setting the and properties. @@ -1724,7 +1724,7 @@ to 0, the is transparent and is not visible. If you set the to 1.0, the is opaque and the selected text is not visible. + If you set the to 0, the is transparent and is not visible. If you set the to 1.0, the is opaque and the selected text is not visible. @@ -1907,12 +1907,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -1984,7 +1984,7 @@ and properties. + The zoom level is constrained by the values of the and properties. ## Dependency Property Information @@ -1997,7 +1997,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: @@ -2044,7 +2044,7 @@ level is increased or decreased when the or commands are executed, respectively. + The zoom increment is the percentage by which the level is increased or decreased when the or commands are executed, respectively. ## Dependency Property Information @@ -2057,7 +2057,7 @@ ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentscrollviewerxaml"::: diff --git a/xml/System.Windows.Controls/Frame.xml b/xml/System.Windows.Controls/Frame.xml index 81efa4526d4..d3b2226b1aa 100644 --- a/xml/System.Windows.Controls/Frame.xml +++ b/xml/System.Windows.Controls/Frame.xml @@ -64,17 +64,17 @@ Content can be any type of .NET Framework object and HTML files. In general, however, pages are the preferred the way to package content for navigation (see ). - Content can be navigated to by setting the property with the URI for the desired content. Additionally, content can be navigated to by using one of the following overloads of the method: + Content can be navigated to by setting the property with the URI for the desired content. Additionally, content can be navigated to by using one of the following overloads of the method: -- +- -- +- - When content is navigated to by URI, returns an object that contains the content. Alternatively, content can be navigated to by using one of the method overloads that accepts an object: + When content is navigated to by URI, returns an object that contains the content. Alternatively, content can be navigated to by using one of the method overloads that accepts an object: -- +- -- +- The lifetime of a navigation can be tracked through the following events: @@ -98,19 +98,19 @@ ![Page navigation flow chart](~/add/media/navigationoverviewfigure11.png "Page navigation flow chart") - During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). + During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). - When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in back and forward navigation history, respectively. + When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in back and forward navigation history, respectively. The first time that one piece of content is navigated to from another piece of content, automatically displays a navigation UI that allows users to navigate back and forward through navigation history. You can configure when the navigation UI is shown by setting the property. By default, will use its own navigation history only if a parent navigator (, ) with its own navigation history cannot be found. This means that navigation history entries for the frame are mingled with navigation history entries for the parent navigator. To specify that a manages its own navigation history, set the property to . - The most recent entry in back navigation history can be removed by calling . + The most recent entry in back navigation history can be removed by calling . does not store an instance of a content object in navigation history. Instead, creates a new instance of the content object each time it is navigated to by using navigation history. This behavior is designed to avoid excessive memory consumption when large numbers and large pieces of content are being navigated to. Consequently, the state of the content is not remembered from one navigation to the next. However, WPF provides several techniques by which you can store a state for a piece of content in navigation history. - Using , you can also remember multiple sets of state for a single page instance. + Using , you can also remember multiple sets of state for a single page instance. ## Customizing the Frame Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [Frame Styles and Templates](/dotnet/framework/wpf/controls/frame-styles-and-templates). @@ -191,7 +191,7 @@ . + See . ]]> @@ -315,7 +315,7 @@ including whole content, fragment navigations, and custom state. + The entries that are returned by including whole content, fragment navigations, and custom state. ## Dependency Property Information @@ -360,7 +360,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -396,7 +396,7 @@ can be set to aid resolution of relative uniform resource identifiers (URIs) for further navigation. + can be set to aid resolution of relative uniform resource identifiers (URIs) for further navigation. To get or set the uniform resource identifier (URI) of the control, use the property. @@ -438,7 +438,7 @@ . + See . ## Dependency Property Information @@ -484,7 +484,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -521,7 +521,7 @@ . + See . ## Dependency Property Information @@ -567,7 +567,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -642,7 +642,7 @@ . + See . ]]> @@ -678,7 +678,7 @@ including whole content, fragment navigations, and custom state. + The entries that are returned by including whole content, fragment navigations, and custom state. ## Dependency Property Information @@ -721,7 +721,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -804,11 +804,11 @@ ## Remarks If navigation history for a frame is managed by a parent navigator (, ), the `GoBack` method on that navigator or associated object must be called: -- +- -- +- -- +- ]]> @@ -854,11 +854,11 @@ ## Remarks If navigation history for a frame is managed by a parent navigator (, ), the `GoForward` method on that navigator or associated object must be called: -- +- -- +- -- +- ]]> @@ -905,7 +905,7 @@ will use its own navigation history only if a parent navigation host (, ) with its own journal cannot be found (for example, if a is hosted in content that is hosted by a ). To force to manage its own navigation history, set to . + By default, will use its own navigation history only if a parent navigation host (, ) with its own journal cannot be found (for example, if a is hosted in content that is hosted by a ). To force to manage its own navigation history, set to . ## Dependency Property Information @@ -955,7 +955,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1050,7 +1050,7 @@ . + See . @@ -1102,7 +1102,7 @@ . + See . > [!NOTE] > Uniform resource identifiers (URIs) can be either relative or absolute. For more information, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). @@ -1110,7 +1110,7 @@ ## Examples - The following example shows how to use the method to navigate to a uniform resource identifier (URI). + The following example shows how to use the method to navigate to a uniform resource identifier (URI). :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/Navigate/MainWindow.xaml.cs" id="Snippetnavigatetopagenavcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/Navigate/mainwindow.xaml.vb" id="Snippetnavigatetopagenavcode"::: @@ -1159,7 +1159,7 @@ . + See . ]]> @@ -1205,7 +1205,7 @@ . + See . ]]> @@ -1409,10 +1409,10 @@ uses to support navigation for hosted content. is useful for code that hosts a to get a reference to the . Content that is hosted by a , such as , should use or to get a reference to the . + uses to support navigation for hosted content. is useful for code that hosts a to get a reference to the . Content that is hosted by a , such as , should use or to get a reference to the . > [!NOTE] -> does not return a reference to the same as calling and passing does. The former returns the that is owned by the while the latter returns the for the navigation host that navigated to the content in which the is hosted. The following code demonstrates the differences. +> does not return a reference to the same as calling and passing does. The former returns the that is owned by the while the latter returns the for the navigation host that navigated to the content in which the is hosted. The following code demonstrates the differences. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/NavigationService/Window1.xaml.cs" id="Snippetnsframediffcode1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/NavigationService/window1.xaml.vb" id="Snippetnsframediffcode1"::: @@ -1501,7 +1501,7 @@ 1. to -2. to +2. to You set to if you want to hide the navigation UI. This might be the case when navigation UI doesn't make sense with the content you are displaying from a , or because you are providing your own navigation UI. @@ -1516,7 +1516,7 @@ ## Examples - The following example demonstrates how to make sure the navigation chrome of a is always visible by setting to . + The following example demonstrates how to make sure the navigation chrome of a is always visible by setting to . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/NavigationUIVisibility/Window1.xaml.cs" id="Snippetsetnavigationuivisibility"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/NavigationUIVisibility/window1.xaml.vb" id="Snippetsetnavigationuivisibility"::: @@ -1555,7 +1555,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1623,9 +1623,9 @@ raises the event. + raises the event. - A type that derives from may override . The overridden method must call on the base class if needs to be raised. + A type that derives from may override . The overridden method must call on the base class if needs to be raised. ]]> @@ -1662,7 +1662,7 @@ . + This method overrides . ]]> @@ -1701,7 +1701,7 @@ . + See . ]]> @@ -1741,7 +1741,7 @@ . + See . ]]> @@ -1781,7 +1781,7 @@ ## Remarks External content is XAML content that is not included with an application as either a resource file or a content file (see [WPF Application Resource, Content, and Data Files](/dotnet/framework/wpf/app-development/wpf-application-resource-content-and-data-files)). - When is `true`, and the source for the content of the is an external XAML file, the content is loaded into a partial trust security sandbox that is limited to the default `Internet` permission set. The external content is subsequently loaded into a separate process. As a result, the external content becomes isolated and does not have access to application-scope resources, such as resource dictionaries (see ). + When is `true`, and the source for the content of the is an external XAML file, the content is loaded into a partial trust security sandbox that is limited to the default `Internet` permission set. The external content is subsequently loaded into a separate process. As a result, the external content becomes isolated and does not have access to application-scope resources, such as resource dictionaries (see ). > [!NOTE] > will only contain external content when the property is set to the uniform resource identifier (URI) for an external XAML file. content that is provided using the property is considered internal content and, subsequently, is not isolated. @@ -1791,7 +1791,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -1829,7 +1829,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1908,7 +1908,7 @@ . + See . > [!NOTE] > Uniform resource identifiers (URIs) can be either relative or absolute. For more information, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). @@ -1919,7 +1919,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1994,7 +1994,7 @@ . + See . ]]> diff --git a/xml/System.Windows.Controls/Grid.xml b/xml/System.Windows.Controls/Grid.xml index 424fb0fa8e9..1ddc1c2abf6 100644 --- a/xml/System.Windows.Controls/Grid.xml +++ b/xml/System.Windows.Controls/Grid.xml @@ -34,7 +34,7 @@ ## Remarks A contains a collection of objects, which are in the property. - Columns and rows that are defined within a can take advantage of sizing to distribute remaining space proportionally. When is selected as the height or width of a row or column, that column or row receives a weighted proportion of the remaining available space. This is in contrast to , which distributes space evenly based on the size of the content that is within a column or row. This value is expressed as `*` or `2*` when you use Extensible Application Markup Language (XAML). In the first case, the row or column would receive one times the available space, while in the second case, the row or column would receive two times the available space, and so on. By combining this technique to proportionally distribute space with a and value of `Stretch`, it is possible to partition layout space by percentage of screen space. is the only layout panel that can distribute space in this manner. + Columns and rows that are defined within a can take advantage of sizing to distribute remaining space proportionally. When is selected as the height or width of a row or column, that column or row receives a weighted proportion of the remaining available space. This is in contrast to , which distributes space evenly based on the size of the content that is within a column or row. This value is expressed as `*` or `2*` when you use Extensible Application Markup Language (XAML). In the first case, the row or column would receive one times the available space, while in the second case, the row or column would receive two times the available space, and so on. By combining this technique to proportionally distribute space with a and value of `Stretch`, it is possible to partition layout space by percentage of screen space. is the only layout panel that can distribute space in this manner. By default, rows and columns take up the least amount of space necessary to accommodate the largest content within any cell contained in a given row or column. For example, if a column has one cell with a long word like "hippopotamus" contained within it but all the other cells in the column have smaller words like "dog", the width of the column will be the width of the largest word (hippopotamus). @@ -587,7 +587,7 @@ ## Remarks Columns and rows participating in size sharing do not respect sizing. In this scenario, sizing is treated as . - Grid size sharing does not work if is set to `true` within a resource template, and a is defined outside of that template. + Grid size sharing does not work if is set to `true` within a resource template, and a is defined outside of that template. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/GridResizeDirection.xml b/xml/System.Windows.Controls/GridResizeDirection.xml index 3e9f6f932d7..ceec3801eff 100644 --- a/xml/System.Windows.Controls/GridResizeDirection.xml +++ b/xml/System.Windows.Controls/GridResizeDirection.xml @@ -39,19 +39,19 @@ How the `Auto` enumeration value affects the redistribution of space in a is set to . + - The is set to . - - The is set to . + - The is set to . - - The is less than or equal to the . + - The is less than or equal to the . - If the following conditions are true, space is redistributed between rows: - - is set to . + - is set to . - - is set to . + - is set to . - - is greater than the . + - is greater than the . ]]> diff --git a/xml/System.Windows.Controls/GridSplitter.xml b/xml/System.Windows.Controls/GridSplitter.xml index a28fc4a0b83..57902b0d7bd 100644 --- a/xml/System.Windows.Controls/GridSplitter.xml +++ b/xml/System.Windows.Controls/GridSplitter.xml @@ -36,21 +36,21 @@ ## Remarks The control redistributes space between rows or columns in a , without changing the dimensions of the . For example, when a resizes two columns, the property of one column is increased while at the same time the property of the other column is decreased by the same amount. - The following table shows how to define a horizontal or vertical by setting the and properties and by leaving the and properties set to their default values. + The following table shows how to define a horizontal or vertical by setting the and properties and by leaving the and properties set to their default values. **How to create vertical and horizontal GridSplitter controls** -|GridSplitter type| value| value| +|GridSplitter type| value| value| |-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| |Resizes rows||, , | |Resizes columns|, , || -|If is greater than or equal to , this resizes the columns.

If is less than , this resizes the rows.||| +|If is greater than or equal to , this resizes the columns.

If is less than , this resizes the rows.||| A can overlap a row or column that contains other content, or it can occupy a row or column by itself. For more information about how to define a , see [How to: Resize Rows with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-rows-with-a-gridsplitter) and [How to: Resize Columns with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-columns-with-a-gridsplitter). - If the and property settings do not achieve the desired behavior, you can change the and property settings. + If the and property settings do not achieve the desired behavior, you can change the and property settings. - A may be obscured by other objects that are contained in the collection of the . For information about how to prevent this situation, see [How to: Make Sure That a GridSplitter Is Visible](/dotnet/framework/wpf/controls/how-to-make-sure-that-a-gridsplitter-is-visible). + A may be obscured by other objects that are contained in the collection of the . For information about how to prevent this situation, see [How to: Make Sure That a GridSplitter Is Visible](/dotnet/framework/wpf/controls/how-to-make-sure-that-a-gridsplitter-is-visible). Dependency properties for this control might be set by the control's default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. @@ -134,7 +134,7 @@ is reinitialized continually as the user drags the mouse. For example, when you drag the by the amount, the rows or columns are resized. To resize the rows and columns more, you must drag the the same amount. Therefore, changes to column and row sizes that are made by using the mouse or the keyboard to move the are made in multiples of the . + The minimum distance that is defined by is reinitialized continually as the user drags the mouse. For example, when you drag the by the amount, the rows or columns are resized. To resize the rows and columns more, you must drag the the same amount. Therefore, changes to column and row sizes that are made by using the mouse or the keyboard to move the are made in multiples of the . ## Dependency Property Information @@ -491,7 +491,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -527,7 +527,7 @@ that resizes rows or columns, set the and properties. If you cannot achieve the desired behavior by setting the and properties, change the or default values. For more information, see [How to: Resize Rows with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-rows-with-a-gridsplitter) and [How to: Resize Columns with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-columns-with-a-gridsplitter). + To specify a that resizes rows or columns, set the and properties. If you cannot achieve the desired behavior by setting the and properties, change the or default values. For more information, see [How to: Resize Rows with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-rows-with-a-gridsplitter) and [How to: Resize Columns with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-columns-with-a-gridsplitter). ## Dependency Property Information @@ -579,7 +579,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -615,7 +615,7 @@ that resizes rows or columns, set the and properties. If you cannot achieve the desired behavior by setting the and properties, change the or default values. For more information, see [How to: Resize Rows with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-rows-with-a-gridsplitter) and [How to: Resize Columns with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-columns-with-a-gridsplitter). + To specify a that resizes rows or columns, set the and properties. If you cannot achieve the desired behavior by setting the and properties, change the or default values. For more information, see [How to: Resize Rows with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-rows-with-a-gridsplitter) and [How to: Resize Columns with a GridSplitter](/dotnet/framework/wpf/controls/how-to-resize-columns-with-a-gridsplitter). ## Dependency Property Information diff --git a/xml/System.Windows.Controls/GridView.xml b/xml/System.Windows.Controls/GridView.xml index a748c299b5f..74b6e009bde 100644 --- a/xml/System.Windows.Controls/GridView.xml +++ b/xml/System.Windows.Controls/GridView.xml @@ -51,7 +51,7 @@ ![ListView with GridView output](~/add/media/listviewgridview.JPG "ListView with GridView output") - The columns in a are defined as objects. In Extensible Application Markup Language (XAML), you can define objects as child elements of the . In code, you can add a to the by using the property and the method that is defined for the class. Similarly, you can use other methods such as and to modify the columns in a . + The columns in a are defined as objects. In Extensible Application Markup Language (XAML), you can define objects as child elements of the . In code, you can add a to the by using the property and the method that is defined for the class. Similarly, you can use other methods such as and to modify the columns in a . The following example shows how to define the columns of a . @@ -66,7 +66,7 @@ ## Examples - The following example shows how to define a control that implements a as its . + The following example shows how to define a control that implements a as its . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window11.xaml" id="Snippet1"::: @@ -272,7 +272,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -311,7 +311,7 @@ that is associated with a , in addition to any styling that was applied to it by the method. + This method removes the that is associated with a , in addition to any styling that was applied to it by the method. ]]> @@ -421,7 +421,7 @@ property and the property are both used to define the visual tree for the objects that represent the column headers in a . The property can also define column header content when a is not by specified by defining a for the object. + The property and the property are both used to define the visual tree for the objects that represent the column headers in a . The property can also define column header content when a is not by specified by defining a for the object. This property represents one of several ways to lay out and style column headers. For more information, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). @@ -498,7 +498,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -577,7 +577,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -613,15 +613,15 @@ , , or property is set, this property is ignored. + If the , , or property is set, this property is ignored. You can use several properties to specify the format of the column headers. If more than one property is set, the column header is formatted with the value of the property that has the highest priority. The format for a column can be set on several types. The following list shows the properties that can be used to format the column headers, ordered from lowest to highest priority: -- +- -- +- -- +- ## Dependency Property Information @@ -766,7 +766,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -838,10 +838,10 @@ One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). `DataTemplateSelectorClassKey` - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to the application resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to the application resource dictionary. `MyDataTemplateSelectorImplementation` - A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). ## Dependency Property Information @@ -885,7 +885,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -950,10 +950,10 @@ ## XAML Values `toolTipContent` - A string that becomes the display text for the . + A string that becomes the display text for the . `toolTipObjectContent` - An object to use as the content for the tooltip. Typically, this object is a or some other element that defines a layout for the , such as a text element. In this usage, a element is implicitly created from the parsed XAML, and the `toolTipObjectContent` content is set as its property. + An object to use as the content for the tooltip. Typically, this object is a or some other element that defines a layout for the , such as a text element. In this usage, a element is implicitly created from the parsed XAML, and the `toolTipObjectContent` content is set as its property. <`ToolTip` .../> See . @@ -1010,7 +1010,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1052,7 +1052,7 @@ , by using methods that are inherited from the class, such as the , , and methods. + This property lets you modify the columns that are defined for a , by using methods that are inherited from the class, such as the , , and methods. ## XAML Property Element Usage @@ -1071,7 +1071,7 @@ ## Examples - The following example shows how to add a to the columns in a by using the method on the property. + The following example shows how to add a to the columns in a by using the method on the property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window1.xaml.cs" id="Snippetaddtocolumns"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/GridView/Overview/window1.xaml.vb" id="Snippetaddtocolumns"::: @@ -1248,7 +1248,7 @@ style of a . To redefine this style, reference the by using the [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension) and assign that value as the [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) of the new . + You can use this read-only static property in Extensible Application Markup Language (XAML) by assigning its static value to another property value. Specifically, this property's static value defines the resource key that is used to look up the default style of a . To redefine this style, reference the by using the [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension) and assign that value as the [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) of the new . ]]> @@ -1284,7 +1284,7 @@ style. To redefine this style, reference the by using the [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension) and assign that value as the [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) of the new . + You can use this read-only static property in Extensible Application Markup Language (XAML) by assigning its static value to another property value. Specifically, this property's static value defines the resource key that is used to look up the default style. To redefine this style, reference the by using the [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension) and assign that value as the [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) of the new . You can use this read-only property in Extensible Application Markup Language (XAML) as an [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) of a that redefines the for the . diff --git a/xml/System.Windows.Controls/GridViewColumn.xml b/xml/System.Windows.Controls/GridViewColumn.xml index 7428d8a4b48..a7ec8c5e125 100644 --- a/xml/System.Windows.Controls/GridViewColumn.xml +++ b/xml/System.Windows.Controls/GridViewColumn.xml @@ -47,15 +47,15 @@ ## Remarks A is used by the view mode to display a column of data. The that implements the view mode provides the data for the column. You use data binding to specify the data for the . - You can use the to define the data to display in a column. You can also define the data as part of a that is specified by the property. If different cells have different objects, the property can specify a . The following list shows the properties mentioned here, in their order of precedence from highest to lowest: + You can use the to define the data to display in a column. You can also define the data as part of a that is specified by the property. If different cells have different objects, the property can specify a . The following list shows the properties mentioned here, in their order of precedence from highest to lowest: -- +- -- +- -- +- - The class also contains properties that you can use to define and customize the column header for the column. The property can define the content of the column header. Other properties such as and can also specify content and style for the column header. Some of these properties are also found on other classes such as the class. For more information about the properties that are used to define styles and templates for column headers, and for information about the order of precedence for these properties, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). + The class also contains properties that you can use to define and customize the column header for the column. The property can define the content of the column header. Other properties such as and can also specify content and style for the column header. Some of these properties are also found on other classes such as the class. For more information about the properties that are used to define styles and templates for column headers, and for information about the order of precedence for these properties, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). The class implements the interface. This interface provides the ability to subscribe to the events that occur when a change occurs to a property value, such as the property value. @@ -137,7 +137,7 @@ ## Remarks You can use this property to get the current width of the when the property is set to . A value of for the property specifies that the column size accommodate the largest visible item that is not the column header. - Unlike , is not a dependency property. + Unlike , is not a dependency property. ]]> @@ -175,9 +175,9 @@ ## Remarks The following properties all bind to and display the content of a column cell, and are listed here in their order of precedence, from highest to lowest: -- -- -- +- +- +- ## XAML Attribute Usage @@ -252,7 +252,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -296,11 +296,11 @@ ## Remarks The following properties all bind to and display the content of a column cell, and are listed here in their order of precedence, from highest to lowest: -- +- -- +- -- +- ## XAML Attribute Usage @@ -323,13 +323,13 @@ ## XAML Values *MyDataTemplateSelectorImplementation* - A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). *ResourceExtension* One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. ## Dependency Property Information @@ -379,7 +379,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -427,9 +427,9 @@ - `DisplayMemberBinding` (this property) -- +- -- +- @@ -474,7 +474,7 @@ property can be set to an object that is as simple as a `string`, or to an object that is as complex as a that has embedded content. The default column header in a view mode is styled as a button that is derived from and that has the content of the property as its child. To specify a template for the column header, see the or property descriptions. + The property can be set to an object that is as simple as a `string`, or to an object that is as complex as a that has embedded content. The default column header in a view mode is styled as a button that is derived from and that has the content of the property as its child. To specify a template for the column header, see the or property descriptions. Properties that define the content, layout, and style of a column header are found on many related classes, and some of these properties have functionality that is similar or the same. For more information, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). @@ -589,13 +589,13 @@ ## Examples - The following example shows how to define a that specifies display properties for a column header. + The following example shows how to define a that specifies display properties for a column header. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/ColumnHeaderContainerStyle/window1.xaml" id="Snippetgridviewheaderstyle"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/ColumnHeaderContainerStyle/window1.xaml" id="Snippetgridviewcolumntemplate"::: - The following example shows how to define a that defines display properties by using a . + The following example shows how to define a that defines display properties by using a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/ColumnHeaderContainerStyle/window1.xaml" id="Snippetgridviewcolumnhctwithcontroltemplatepart1"::: @@ -636,7 +636,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -671,7 +671,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -707,15 +707,15 @@ , , or property is set, this property is ignored. + If the , , or property is set, this property is ignored. You can use several properties to specify the format of the column headers. If more than one property is set, the column header is formatted with the value of the property that has the highest priority. The format for a column can be set on several types. The following list shows the properties that can be used to format the column headers, ordered from lowest to highest priority: -- +- -- +- -- +- ## Dependency Property Information @@ -789,9 +789,9 @@ ## Remarks If both the property and the property are set, the property takes precedence. - After a or is specified for a , it cannot be changed. + After a or is specified for a , it cannot be changed. - You can also define the display of a column header by specifying a as part of a . + You can also define the display of a column header by specifying a as part of a . Properties that define the content, layout, and style of a column header are found on many related classes, and some of these properties have functionality that is similar or the same. For more information, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). @@ -869,7 +869,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -939,10 +939,10 @@ One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. *MyDataTemplateSelectorImplementation* - A class that derives from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class that derives from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). ## Dependency Property Information @@ -985,7 +985,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1193,7 +1193,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1238,7 +1238,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls/GridViewColumnCollection.xml b/xml/System.Windows.Controls/GridViewColumnCollection.xml index 8ef0393b4da..b6db109a870 100644 --- a/xml/System.Windows.Controls/GridViewColumnCollection.xml +++ b/xml/System.Windows.Controls/GridViewColumnCollection.xml @@ -34,13 +34,13 @@ Represents a collection of objects. - object contains a set of objects that are typically used to define the columns of a object. A is a that defines the layout of data in a control. - - To receive notification of changes in the collection, monitor the event that is inherited from . - + object contains a set of objects that are typically used to define the columns of a object. A is a that defines the layout of data in a control. + + To receive notification of changes in the collection, monitor the event that is inherited from . + ]]> @@ -139,11 +139,11 @@ The to insert. Adds a to the collection at the specified index. - without replacing another item. To replace an item in the collection with a new item, use the method. - + without replacing another item. To replace an item in the collection with a new item, use the method. + ]]> @@ -282,11 +282,11 @@ The to place at the specified position. Replaces the that is at the specified index with another . - with a new column. To insert a new column without replacing another column, use the method. - + with a new column. To insert a new column without replacing another column, use the method. + ]]> diff --git a/xml/System.Windows.Controls/GridViewColumnHeader.xml b/xml/System.Windows.Controls/GridViewColumnHeader.xml index cf31dbeced6..0bb2c17abdb 100644 --- a/xml/System.Windows.Controls/GridViewColumnHeader.xml +++ b/xml/System.Windows.Controls/GridViewColumnHeader.xml @@ -164,7 +164,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -232,7 +232,7 @@ of the and updates the floating version of the header when the property is set to . + This method sets the of the and updates the floating version of the header when the property is set to . ]]> @@ -337,7 +337,7 @@ implementation of clears mouse capture. + The implementation of clears mouse capture. This implementation does not change the property of the . @@ -456,7 +456,7 @@ event so that the can support the drag-and-drop operation that moves a column. This method captures the mouse and sets the event argument to `true`. + This implementation handles the event so that the can support the drag-and-drop operation that moves a column. This method captures the mouse and sets the event argument to `true`. ]]> @@ -495,9 +495,9 @@ event (which occurs when the property in the is set to `true`). It also ends the mouse capture that was set by the method. This provides a way for the to support the drag-and-drop operation that moves a column. + This implementation handles the event (which occurs when the property in the is set to `true`). It also ends the mouse capture that was set by the method. This provides a way for the to support the drag-and-drop operation that moves a column. - This method sets the event argument to `true`. + This method sets the event argument to `true`. ]]> @@ -538,7 +538,7 @@ ## Remarks This implementation keeps the left mouse button in a pressed state while a is moved by a drag-and-drop operation. This also causes the property of the to remain set to `true` when the mouse with its left mouse button pressed moves off the header. - This implementation keeps the event argument set to `false` for the event so that the method can support the drag-and-drop operation that moves a column. + This implementation keeps the event argument set to `false` for the event so that the method can support the drag-and-drop operation that moves a column. ]]> @@ -612,7 +612,7 @@ class performs layout for the column headers in a and places an additional column header at the end to add space. A value of identifies this column header in the . A value of identifies a column that is currently the object of a drag-and-drop operation. + The class performs layout for the column headers in a and places an additional column header at the end to add space. A value of identifies this column header in the . A value of identifies a column that is currently the object of a drag-and-drop operation. ## Dependency Property Information @@ -656,7 +656,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls/GridViewHeaderRowPresenter.xml b/xml/System.Windows.Controls/GridViewHeaderRowPresenter.xml index 8bda2c9103b..ff37e23f0db 100644 --- a/xml/System.Windows.Controls/GridViewHeaderRowPresenter.xml +++ b/xml/System.Windows.Controls/GridViewHeaderRowPresenter.xml @@ -33,9 +33,9 @@ object and objects are support objects for the mode that displays data in columns for a . For more information about how to define a view, see the [GridView Overview](/dotnet/framework/wpf/controls/gridview-overview). + This object and objects are support objects for the mode that displays data in columns for a . For more information about how to define a view, see the [GridView Overview](/dotnet/framework/wpf/controls/gridview-overview). - You can determine when a column is moving to a new location by monitoring the event that is defined for the . + You can determine when a column is moving to a new location by monitoring the event that is defined for the . You can customize column headers in a view mode by using a variety of properties that are found in this class and in related classes. For more information about these properties, and about the precedence between them, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). @@ -152,7 +152,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -289,7 +289,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -370,7 +370,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -412,15 +412,15 @@ , , or property is set, this property is ignored. + If the , , or property is set, this property is ignored. You can use several properties to specify the format of the column headers. If more than one property is set, the column header is formatted with the value of the property that has the highest priority. The format for a column can be set on several types. The following list shows the properties that can be used to format the column headers, ordered from lowest to highest priority: -- +- -- +- -- +- ## Dependency Property Information @@ -494,7 +494,7 @@ ## Remarks When you implement this class as part of a view mode, the value of this property is bound to the value of the property on the . - If the property and the property are both set, the takes precedence. + If the property and the property are both set, the takes precedence. You can customize column headers in a view mode by using a variety of properties that are found in this class and in related classes. For more information about these properties, and about the precedence between them, see [GridView Column Header Styles and Templates Overview](/dotnet/framework/wpf/controls/gridview-column-header-styles-and-templates-overview). @@ -553,7 +553,7 @@ dependency property. + The identifier for dependency property. ]]> @@ -595,7 +595,7 @@ property and the property are both set, the takes precedence. + If the property and the property are both set, the takes precedence. When you implement this class as part of a view mode, the value of this property is bound to the value of the property on the . @@ -622,13 +622,13 @@ ## XAML Values *MyDataTemplateSelectorImplementation* - A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). *ResourceExtension* One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. ]]> @@ -664,7 +664,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -731,10 +731,10 @@ ## XAML Values `toolTipContent` - A string that becomes the display text for the . + A string that becomes the display text for the . `toolTipObjectContent` - An object to use as the content for the tooltip. Typically, this object is a or some other element that defines a layout for the , such as a text element. In this usage, a element is implicitly created from the parsed XAML, and the `toolTipObjectContent` content is set as its property. + An object to use as the content for the tooltip. Typically, this object is a or some other element that defines a layout for the , such as a text element. In this usage, a element is implicitly created from the parsed XAML, and the `toolTipObjectContent` content is set as its property. <`ToolTip` .../> See . @@ -780,7 +780,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -923,9 +923,9 @@ is `true`, this method prepares a column to be dragged to another location in the column header row. + If is `true`, this method prepares a column to be dragged to another location in the column header row. - This implementation handles the event by setting the event argument to `true`. + This implementation handles the event by setting the event argument to `true`. ]]> @@ -964,9 +964,9 @@ is `true`, and if the event occurs after a column is dragged to a new location, the column is moved. + If is `true`, and if the event occurs after a column is dragged to a new location, the column is moved. - This implementation handles the event by setting the event argument to `true`. + This implementation handles the event by setting the event argument to `true`. ]]> @@ -1005,7 +1005,7 @@ property is set to `true` and the user presses the left mouse button, this method implements the visual behavior that occurs when the user drags a to a new location. This method override sets the event argument to `true` for the event even if the user does not press the left mouse button. + If the property is set to `true` and the user presses the left mouse button, this method implements the visual behavior that occurs when the user drags a to a new location. This method override sets the event argument to `true` for the event even if the user does not press the left mouse button. ]]> diff --git a/xml/System.Windows.Controls/GridViewRowPresenter.xml b/xml/System.Windows.Controls/GridViewRowPresenter.xml index 7fbb1999920..68238cc712a 100644 --- a/xml/System.Windows.Controls/GridViewRowPresenter.xml +++ b/xml/System.Windows.Controls/GridViewRowPresenter.xml @@ -148,7 +148,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -183,7 +183,7 @@ dependency property. + The identifier for the dependency property. diff --git a/xml/System.Windows.Controls/GroupBox.xml b/xml/System.Windows.Controls/GroupBox.xml index bc91f60696d..77d547b0455 100644 --- a/xml/System.Windows.Controls/GroupBox.xml +++ b/xml/System.Windows.Controls/GroupBox.xml @@ -34,7 +34,7 @@ is a , which means its and properties can be of any type (such as string, image, or panel). For more information, see the class. + is a , which means its and properties can be of any type (such as string, image, or panel). For more information, see the class. The following illustration is an example of a that contains a and a that are enclosed in a . diff --git a/xml/System.Windows.Controls/GroupItem.xml b/xml/System.Windows.Controls/GroupItem.xml index 4e566dd8ccc..863de852586 100644 --- a/xml/System.Windows.Controls/GroupItem.xml +++ b/xml/System.Windows.Controls/GroupItem.xml @@ -38,13 +38,13 @@ Appears as the root of the visual subtree generated for a group. - is a , which means that it can contain a single object of any type (such as a string, an image, or a panel). For more information, see the class. - + is a , which means that it can contain a single object of any type (such as a string, an image, or a panel). For more information, see the class. + Dependency properties for this control might be set by the control's default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. - + ]]> @@ -138,11 +138,11 @@ Builds the visual tree for the when a new template is applied. - method. - + method. + ]]> @@ -382,11 +382,11 @@ Gets or sets an object that represents the sizes of the control's viewport and cache. An object that represents the sizes of the control's viewport and cache. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -420,11 +420,11 @@ Gets an object that represents the desired size of the control's header. An object that represents the desired size of the control's header. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -459,11 +459,11 @@ if the control's layout pass occurs at a lower priority; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -497,11 +497,11 @@ Gets or sets an object that represents the desired size of the control's items. An object that represents the desired size of the control's items. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -535,11 +535,11 @@ Gets the that displays the items of the control. The that displays the items of the control. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -574,11 +574,11 @@ if the owning should virtualize its items; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Controls/GroupStyle.xml b/xml/System.Windows.Controls/GroupStyle.xml index 6a0f2c50445..f890eba667a 100644 --- a/xml/System.Windows.Controls/GroupStyle.xml +++ b/xml/System.Windows.Controls/GroupStyle.xml @@ -40,7 +40,7 @@ ## Examples The following examples show an that is bound to an and the code-behind content that contains the logic to add and remove grouping. When the check box is checked, the content of the is grouped by the `Type` attribute. - Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. + Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GroupStyle/Overview/Window1.xaml" id="Snippetxaml"::: @@ -117,9 +117,9 @@ property and the attached property enable you to specify the appearance for two or more alternating objects. For example, you can specify alternating background colors for every third in an . The is assigned to each in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven objects in the , the following table lists the for each item. + The property and the attached property enable you to specify the appearance for two or more alternating objects. For example, you can specify alternating background colors for every third in an . The is assigned to each in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven objects in the , the following table lists the for each item. -|Position of in the || +|Position of in the || |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| |1|0| |2|1| @@ -129,20 +129,20 @@ |6|2| |7|0| - There are several methods you can use to specify different appearances for the alternating objects. One method is to bind properties in the or of the to the . You can then use an to specify which value should be applied to the that has a certain value. You can also use triggers to change the value of a property depending on the value of its . + There are several methods you can use to specify different appearances for the alternating objects. One method is to bind properties in the or of the to the . You can then use an to specify which value should be applied to the that has a certain value. You can also use triggers to change the value of a property depending on the value of its . ## Examples The following example creates a that is bound to a that groups the items in the collection. The example alternates the background for the header of each between two colors by doing the following: -- Sets to 2. +- Sets to 2. -- Creates an that returns a , depending on the value of . +- Creates an that returns a , depending on the value of . -- Binds the of the in the to the property and provides the . Note that the attached property is set on the , and the binding uses to get its value. +- Binds the of the in the to the property and provides the . Note that the attached property is set on the , and the binding uses to get its value. - The example also alternates the background of the items in the between three colors by setting the on the and binding the of each to the . In this case, the background alternates between three colors. + The example also alternates the background of the items in the between three colors by setting the on the and binding the of each to the . In this case, the background alternates between three colors. The that groups the items is not shown. For information on how to group item, see [How to: Sort and Group Data Using a View in XAML](/dotnet/framework/wpf/data/how-to-sort-and-group-data-using-a-view-in-xaml). @@ -382,12 +382,12 @@ can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. ## Examples - The following example creates a that groups a collection of items by price range. The converter, `GroupByPrice`, returns an integer value that is above each item's price. For example, if an item's price is between 0 and 100, the converter returns 100. The example uses the to create a string that includes the upper limit for each price range. For example, in the United States, items that are under 100 dollars are grouped under a heading that says "Items under $100". + The following example creates a that groups a collection of items by price range. The converter, `GroupByPrice`, returns an integer value that is above each item's price. For example, if an item's price is between 0 and 100, the converter returns 100. The example uses the to create a string that includes the upper limit for each price range. For example, in the United States, items that are under 100 dollars are grouped under a heading that says "Items under $100". :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml" id="Snippetgroupstyleheaderstringformat"::: @@ -442,7 +442,7 @@ ## Examples The following examples show an that is bound to an and the code-behind content that contains the logic to add and remove grouping. When the check box is checked, the content of the is grouped by the `Type` attribute. - Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. + Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GroupStyle/Overview/Window1.xaml" id="Snippetxaml"::: diff --git a/xml/System.Windows.Controls/HeaderedContentControl.xml b/xml/System.Windows.Controls/HeaderedContentControl.xml index dc36510365c..f1a88fb897e 100644 --- a/xml/System.Windows.Controls/HeaderedContentControl.xml +++ b/xml/System.Windows.Controls/HeaderedContentControl.xml @@ -34,9 +34,9 @@ inherits the property from and defines the property that is of type . provides a heading for the control. Like the property of a , the can be any type. + inherits the property from and defines the property that is of type . provides a heading for the control. Like the property of a , the can be any type. - The following illustration shows two objects, which inherit from . The first has objects as the content in both the and the : the is set to a that contains an and a ; the is set to a that contains a and a . The of the second is set to a string and the is set to a single . + The following illustration shows two objects, which inherit from . The first has objects as the content in both the and the : the is set to a that contains an and a ; the is set to a that contains a and a . The of the second is set to a string and the is set to a single . ![TabControl](~/add/media/controlcontentmodelteabitem.PNG "TabControl") TabControl with different types in the Header property @@ -227,7 +227,7 @@ TabControl with different types in the Header property property of a , the can be any type. The uses the same logic to display the that is described in . + Like the property of a , the can be any type. The uses the same logic to display the that is described in . ## Dependency Property Information @@ -240,7 +240,7 @@ TabControl with different types in the Header property ## Examples - The following example creates a that contains two objects, which inherit from . The first has objects as the content in both the and the : the is set to a that contains an and a ; the is set to a that contains a and a . The of the second is set to a string and the is set to a single . + The following example creates a that contains two objects, which inherit from . The first has objects as the content in both the and the : the is set to a that contains an and a ; the is set to a that contains a and a . The of the second is set to a string and the is set to a single . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml" id="Snippet16"::: @@ -249,7 +249,7 @@ TabControl with different types in the Header property ![TabControl](~/add/media/controlcontentmodelteabitem.PNG "TabControl") TabControl with different types in the Header property - The following example creates two objects to specify the appearance of the and of the . + The following example creates two objects to specify the appearance of the and of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/ContentSource/Page1.xaml" id="Snippetheadertemplate1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/ContentSource/Page1.xaml" id="Snippetheadertemplate2"::: @@ -322,7 +322,7 @@ TabControl with different types in the Header property can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or property of a , the property is ignored. ## Dependency Property Information @@ -335,11 +335,11 @@ TabControl with different types in the Header property ## Examples - The following example binds a to a collection of `Student` objects. The `Student` class has a `Name` property, a collection of `Course` objects, and implements the method to return either the `Name` of the student or a string that lists the student's courses. The example uses to put a student's name in the of each (which inherits from ), and the to display the course list for each student in the Content of the . + The following example binds a to a collection of `Student` objects. The `Student` class has a `Name` property, a collection of `Course` objects, and implements the method to return either the `Name` of the student or a string that lists the student's courses. The example uses to put a student's name in the of each (which inherits from ), and the to display the course list for each student in the Content of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml" id="Snippettabcontrol"::: - The following example implements the method to return either the `Name` of the student or a string that lists the student's courses. + The following example implements the method to return either the `Name` of the student or a string that lists the student's courses. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml.cs" id="Snippettabcontroltostring"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/GroupStyle/HeaderStringFormat/window1.xaml.vb" id="Snippettabcontroltostring"::: @@ -449,7 +449,7 @@ TabControl with different types in the Header property ## Examples - The following example creates two objects to specify the appearance of the and of the . + The following example creates two objects to specify the appearance of the and of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/ContentSource/Page1.xaml" id="Snippetheadertemplate1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/ContentSource/Page1.xaml" id="Snippetheadertemplate2"::: @@ -526,7 +526,7 @@ TabControl with different types in the Header property and the properties are set, the template selector property is ignored. + If both the and the properties are set, the template selector property is ignored. ## XAML Attribute Usage @@ -549,13 +549,13 @@ TabControl with different types in the Header property ## XAML Values *MyDataTemplateSelectorImplementation* - A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). *ResourceExtension* One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/HeaderedItemsControl.xml b/xml/System.Windows.Controls/HeaderedItemsControl.xml index 4a54bff1e1c..1c333d3a05b 100644 --- a/xml/System.Windows.Controls/HeaderedItemsControl.xml +++ b/xml/System.Windows.Controls/HeaderedItemsControl.xml @@ -47,7 +47,7 @@ A has a limited default style. To create a with a custom appearance, create a new . - Set the property to specify the label of the . can be any type of object. Set the property to a to customize the header. For more information about data templates, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). + Set the property to specify the label of the . can be any type of object. Set the property to a to customize the header. For more information about data templates, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). Dependency properties for this control might be set by the control's default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. @@ -60,7 +60,7 @@ - A object. -- A object that contains a in its . +- A object that contains a in its . - A object whose property is set to a that contains two objects. @@ -236,7 +236,7 @@ property is of type , there are no restrictions on what you can put in the . The is displayed by a , which is in the of the . For more information about how the displays the , see . + Because the property is of type , there are no restrictions on what you can put in the . The is displayed by a , which is in the of the . For more information about how the displays the , see . ## XAML Attribute Usage @@ -521,9 +521,9 @@ ## Remarks Typically, you create a when you have more than one for the same type of objects and you want to supply your own logic to choose a to apply based on the properties of each data object. Note that if you have objects of different types you can set the property on the . If you do that, then there is no need to create a . Furthermore, if you have objects of the same type but with different properties, you can also consider using a or a data converter. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. + To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. - If both the and the properties are set, the template selector property is ignored. + If both the and the properties are set, the template selector property is ignored. ## XAML Attribute Usage @@ -546,13 +546,13 @@ ## XAML Values *MyDataTemplateSelectorImplementation* - A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). *ResourceExtension* One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/Image.xml b/xml/System.Windows.Controls/Image.xml index 05a8d4c0abe..afdef6ba3a2 100644 --- a/xml/System.Windows.Controls/Image.xml +++ b/xml/System.Windows.Controls/Image.xml @@ -42,9 +42,9 @@ When displaying a multiframe image, only the first frame is displayed. The animation of multiframe images is not supported by the control. - Until the image content is loaded, the and of the control will report as zero, because the image content is used to determine the final size and location of the control. + Until the image content is loaded, the and of the control will report as zero, because the image content is used to determine the final size and location of the control. - For a fixed size control, the and/or properties can be set. However, to preserve the media's aspect ratio, set the or properties but not both. + For a fixed size control, the and/or properties can be set. However, to preserve the media's aspect ratio, set the or properties but not both. ]]> @@ -233,7 +233,7 @@ is a and it fails to load, due to a corrupt header, both the and events occur. + If the is a and it fails to load, due to a corrupt header, both the and events occur. ## XAML Text Usage @@ -246,7 +246,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate|, constrained by | +|Delegate|, constrained by | ]]> @@ -484,7 +484,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|,

| +|Metadata properties set to `true`|,

| @@ -566,7 +566,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -618,7 +618,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/InkCanvas.xml b/xml/System.Windows.Controls/InkCanvas.xml index 0318b5adbf1..ec43ce7c098 100644 --- a/xml/System.Windows.Controls/InkCanvas.xml +++ b/xml/System.Windows.Controls/InkCanvas.xml @@ -40,7 +40,7 @@ ## Remarks An is an element that can be used to receive and display ink input. This is commonly done through the use of a stylus, which interacts with a digitizer to produce ink strokes using a stylus or a mouse. The created strokes are represented as objects, and can be manipulated either programmatically or based on user input. The enables users to modify or delete an existing . - The can be bound to a data source. For example, you can bind the property to: a base-64, encoded string that contains ink data in Ink Serialized format (ISF); or even to the property of another . You can also bind properties, such as and , to other data sources. + The can be bound to a data source. For example, you can bind the property to: a base-64, encoded string that contains ink data in Ink Serialized format (ISF); or even to the property of another . You can also bind properties, such as and , to other data sources. @@ -50,7 +50,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.vb" id="Snippet3"::: - The following example declares two objects in XAML and establishes data binding between them and other data sources. The first , called `ic`, is bound to two data sources. The and properties on `ic` are bound to objects, which are, in turn, bound to arrays defined in the XAML. The , , and properties of the second are bound to the first in the following code. + The following example declares two objects in XAML and establishes data binding between them and other data sources. The first , called `ic`, is bound to two data sources. The and properties on `ic` are bound to objects, which are, in turn, bound to arrays defined in the XAML. The , , and properties of the second are bound to the first in the following code. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/Overview/Window11.xaml" id="Snippet1"::: @@ -114,7 +114,7 @@ property indicates the current of the . Suppose that the is set to and the is set to . When the tablet pen is used in an inverted position, has a value of . Otherwise, its value is . + The property indicates the current of the . Suppose that the is set to and the is set to . When the tablet pen is used in an inverted position, has a value of . Otherwise, its value is . ## Dependency Property Information @@ -127,7 +127,7 @@ ## Examples - The following example reports the value of whenever it changes. + The following example reports the value of whenever it changes. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet36"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet36"::: @@ -171,7 +171,7 @@ property changes whenever the enters a new editing mode. For example, suppose that the is set to and the is set to . When the user changes the tip of tablet pen, the event occurs. + The property changes whenever the enters a new editing mode. For example, suppose that the is set to and the is set to . When the user changes the tip of tablet pen, the event occurs. ## Routed Event Information @@ -185,7 +185,7 @@ ## Examples - The following example reports the value of whenever it changes. + The following example reports the value of whenever it changes. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet36"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet36"::: @@ -331,7 +331,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -842,10 +842,10 @@ ## Examples - The following example sets the so that the stylus points of the strokes on the contain the , , , and properties. + The following example sets the so that the stylus points of the strokes on the contain the , , , and properties. > [!NOTE] -> Only the strokes that are added to the after the is set to contain the additional property. +> Only the strokes that are added to the after the is set to contain the additional property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet9"::: @@ -890,7 +890,7 @@ You can set the property to a custom if you want to customize the ink. > [!NOTE] -> The is a member of the collection. When you set the , the removes the old from the and adds the new to the end of the collection. This may change the behavior of the . +> The is a member of the collection. When you set the , the removes the old from the and adds the new to the end of the collection. This may change the behavior of the . ]]> @@ -926,9 +926,9 @@ is . Changing the clears any existing selections. + The default is . Changing the clears any existing selections. - The specifies the mode of the pointing device as it interacts with the . is used by some digitizers when the "eraser end" of the stylus contacts the digitizer. + The specifies the mode of the pointing device as it interacts with the . is used by some digitizers when the "eraser end" of the stylus contacts the digitizer. ## Dependency Property Information @@ -1269,11 +1269,11 @@ when the current is set to . + This shape will be used to erase ink from an when the current is set to . Individual properties of a cannot be modified once the shape has been created. - If you change the , the cursor rendered on the is not updated until the next change. + If you change the , the cursor rendered on the is not updated until the next change. ## XAML Text Usage @@ -1624,9 +1624,9 @@ ## Remarks This method returns only objects, not objects. - To retrieve selected objects, call the method. + To retrieve selected objects, call the method. - If the of is set to , users can select objects and objects. Alternatively, both types of objects can be selected using code: just call the method. + If the of is set to , users can select objects and objects. Alternatively, both types of objects can be selected using code: just call the method. @@ -1673,9 +1673,9 @@ objects, only. To retrieve selected objects, call the method. + This method returns objects, only. To retrieve selected objects, call the method. - If the of is set to , users can select objects and objects. Alternatively, both types of objects can be selected using code: just call the method. + If the of is set to , users can select objects and objects. Alternatively, both types of objects can be selected using code: just call the method. @@ -1889,12 +1889,12 @@ method to determine whether the point is within a stroke selection's bounds or on one of the eight handles. This is useful when performing drag and drop operations. + Use the method to determine whether the point is within a stroke selection's bounds or on one of the eight handles. This is useful when performing drag and drop operations. ## Examples - The following example demonstrates how use to determine whether to create a to initiate drag and drop. To implement drag and drop between two objects, see [How to: Drag and Drop Ink](/dotnet/framework/wpf/advanced/how-to-drag-and-drop-ink). + The following example demonstrates how use to determine whether to create a to initiate drag and drop. To implement drag and drop between two objects, see [How to: Drag and Drop Ink](/dotnet/framework/wpf/advanced/how-to-drag-and-drop-ink). :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/HitTestSelection/Window1.xaml.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/HitTestSelection/Window1.xaml.vb" id="Snippet3"::: @@ -2172,7 +2172,7 @@ is `true`, the adorner enables the user to resize the strokes and/or elements as well. + If this property is set to `true`, an adorner border is drawn around ink strokes and/or elements when they are selected. This border enables the user to move the selected objects. If is `true`, the adorner enables the user to resize the strokes and/or elements as well. If this property is set to `false` while one or more ink strokes and/or elements are selected, the adorner border will be automatically removed from the selected objects. @@ -2458,7 +2458,7 @@ method is called. + This method is called after a set of ink strokes and/or elements has been selected by the user and the selection change has been applied. Before the change is applied, the method is called. ]]> @@ -2498,7 +2498,7 @@ method is called. + This method is called when a new selection of strokes and/or elements is made by the user, but before the change is applied. After the change has been applied, the method is called. ]]> @@ -2538,7 +2538,7 @@ method is called. + This method is called after a selection of strokes and/or elements has been moved by the user and the change has been applied. Before the change is applied, the method is called. ]]> @@ -2578,7 +2578,7 @@ method is called. + This method is called after the user requests that a selection of strokes and/or elements be moved and before the change is applied. After the change is applied, the method is called. ]]> @@ -2618,7 +2618,7 @@ method is called. + This method is called after a selection of strokes and/or elements has been resized by the user and the change has been applied. Before the change is applied, the method is called. ]]> @@ -2658,7 +2658,7 @@ method will be called. + This method is called after the user requests a selection of strokes and/or elements be resized and before the change is applied. After the change is applied, the method will be called. ]]> @@ -2698,9 +2698,9 @@ is called when a user physically completes a stroke, for example, by raising the stylus from a tablet after making a motion. + is called when a user physically completes a stroke, for example, by raising the stylus from a tablet after making a motion. - A programmatic addition of strokes to the collection will not call the method. + A programmatic addition of strokes to the collection will not call the method. ]]> @@ -2970,7 +2970,7 @@ ## Examples - The following example sets the to make the accept Extensible Application Markup Language (XAML) format, Ink Serialized Format (ISF). + The following example sets the to make the accept Extensible Application Markup Language (XAML) format, Ink Serialized Format (ISF). :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet26"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet26"::: @@ -3014,7 +3014,7 @@ is `true`, the adorner enables the user to move the strokes and/or elements as well. + If this property is set to `true`, an adorner border is drawn around ink strokes and/or elements when they are selected. This border enables the user to resize the selected objects. If is `true`, the adorner enables the user to move the strokes and/or elements as well. If this property is set to `false` while one or more ink strokes and/or elements are selected, the adorner border is automatically removed from the selected objects. @@ -3188,7 +3188,7 @@ ## Remarks An can contain objects, which are created in response to user stylus input and objects, such as and objects. - Selected strokes are displayed with an adorner around them for ease of recognition and manipulation. objects will not display differently when selected. If a in `selectedElements` is not in the Children collection, ignores the . + Selected strokes are displayed with an adorner around them for ease of recognition and manipulation. objects will not display differently when selected. If a in `selectedElements` is not in the Children collection, ignores the . @@ -3295,7 +3295,7 @@ ## Remarks An can contain objects, which are created in response to user stylus input and objects, such as and objects. - Selected strokes will be displayed with an adorner around them for ease of recognition and manipulation. objects will not display differently when selected. If a in `selectedElements` is not in the Children collection, ignores the . + Selected strokes will be displayed with an adorner around them for ease of recognition and manipulation. objects will not display differently when selected. If a in `selectedElements` is not in the Children collection, ignores the . @@ -3493,7 +3493,7 @@ ## Remarks This event occurs after the user requests that a selection of strokes and/or elements be moved, but before the change is applied. - The event handler receives an argument of type with two properties: and . defines the boundaries of the selection before the move and defines the boundaries of the selection after the move. + The event handler receives an argument of type with two properties: and . defines the boundaries of the selection before the move and defines the boundaries of the selection after the move. After the change is applied, the event will occur. @@ -3593,7 +3593,7 @@ ## Remarks This event occurs after the user requests that a selection of strokes and/or elements be resized, but before the change is applied. - The event handler receives an argument of type that contains two properties: and . defines the boundaries of the selection before the resizing operation and defines the boundaries of the selection after the resizing operation. + The event handler receives an argument of type that contains two properties: and . defines the boundaries of the selection before the resizing operation and defines the boundaries of the selection after the resizing operation. After the strokes and/or elements are updated with the new size, the event is raised. @@ -3872,7 +3872,7 @@ The event handler receives an argument of type , which references the completed stroke. The stroke is also added to the property of the . - The programmatic addition of a object to the collection does not raise this event. + The programmatic addition of a object to the collection does not raise this event. ## Routed Event Information @@ -3973,7 +3973,7 @@ ## Examples - The following example reports the number of strokes that are on an when the event occurs. If is set to and the user erases the middle of a stroke, the number of strokes on the increases. This is because the old stroke was replaced by two new strokes. + The following example reports the number of strokes that are on an when the event occurs. If is set to and the user erases the middle of a stroke, the number of strokes on the increases. This is because the old stroke was replaced by two new strokes. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet18"::: @@ -4040,7 +4040,7 @@ property to `true` if you want to prevent the stroke from being erased. You can use this technique when the or property is set to or . + Handle this event when you want to check whether a stroke should be erased. Set the property to `true` if you want to prevent the stroke from being erased. You can use this technique when the or property is set to or . @@ -4382,7 +4382,7 @@ will change the cursor style to reflect the current while the cursor is within the bounds of the . If this behavior is not wanted, for example, when the uses a custom cursor, set this property to `true`, and the cursor will not change with the . + The will change the cursor style to reflect the current while the cursor is within the bounds of the . If this behavior is not wanted, for example, when the uses a custom cursor, set this property to `true`, and the cursor will not change with the . diff --git a/xml/System.Windows.Controls/InkCanvasClipboardFormat.xml b/xml/System.Windows.Controls/InkCanvasClipboardFormat.xml index c51e6e41195..d976261c8e9 100644 --- a/xml/System.Windows.Controls/InkCanvasClipboardFormat.xml +++ b/xml/System.Windows.Controls/InkCanvasClipboardFormat.xml @@ -23,14 +23,14 @@ Specifies the formats that an will accept from the Clipboard. - to make the accept Extensible Application Markup Language (XAML) format, Ink Serialized Format (ISF). - + to make the accept Extensible Application Markup Language (XAML) format, Ink Serialized Format (ISF). + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet26"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet26"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet26"::: + ]]> diff --git a/xml/System.Windows.Controls/InkCanvasEditingMode.xml b/xml/System.Windows.Controls/InkCanvasEditingMode.xml index e325c2dae98..52bddafc4d5 100644 --- a/xml/System.Windows.Controls/InkCanvasEditingMode.xml +++ b/xml/System.Windows.Controls/InkCanvasEditingMode.xml @@ -23,19 +23,19 @@ Specifies the editing mode for the . - and properties use the to specify how the behaves when it receives input from a tablet pen. - - - -## Examples - The following example demonstrates how to allow users to partially erase strokes with the inverted tip of a stylus. An elliptical cursor appears on the when the user erases ink. - + and properties use the to specify how the behaves when it receives input from a tablet pen. + + + +## Examples + The following example demonstrates how to allow users to partially erase strokes with the inverted tip of a stylus. An elliptical cursor appears on the when the user erases ink. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/ActiveEditingMode/Window1.xaml.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Windows.Controls/InkCanvasGestureEventArgs.xml b/xml/System.Windows.Controls/InkCanvasGestureEventArgs.xml index 9cbf2668a16..0efc6a88a8f 100644 --- a/xml/System.Windows.Controls/InkCanvasGestureEventArgs.xml +++ b/xml/System.Windows.Controls/InkCanvasGestureEventArgs.xml @@ -98,7 +98,7 @@ event occurs, the value of the property depends on the first in the collection returned by the method. If the value of the property is , or if it is a gesture whose is a value other than , then is `true`. Otherwise, is `false`. When is `false`, the adds the to its . When is `true`, the strokes are not added to the . + When the event occurs, the value of the property depends on the first in the collection returned by the method. If the value of the property is , or if it is a gesture whose is a value other than , then is `true`. Otherwise, is `false`. When is `false`, the adds the to its . When is `true`, the strokes are not added to the . ]]> @@ -135,7 +135,7 @@ method is sorted by the property. For example, might return a collection of objects with the following values: + The collection returned by the method is sorted by the property. For example, might return a collection of objects with the following values: |Index|ApplicationGesture|RecognitionConfidence| |-----------|------------------------|---------------------------| @@ -147,7 +147,7 @@ This means that the recognizes that it is very likely that the is a check mark, relatively likely that the in not a gesture, and not at all likely that the is a curlicue or a double curlicue. > [!NOTE] -> The method can return an array with with a higher degree of than it has for other application gestures. This means that it is more likely that the is not a gesture, as opposed to a gesture that has a lower . +> The method can return an array with with a higher degree of than it has for other application gestures. This means that it is more likely that the is not a gesture, as opposed to a gesture that has a lower . ]]> diff --git a/xml/System.Windows.Controls/InkCanvasSelectionHitResult.xml b/xml/System.Windows.Controls/InkCanvasSelectionHitResult.xml index b102fa3b76e..89a390e1aea 100644 --- a/xml/System.Windows.Controls/InkCanvasSelectionHitResult.xml +++ b/xml/System.Windows.Controls/InkCanvasSelectionHitResult.xml @@ -23,23 +23,23 @@ Identifies the various parts of a selection adorner on an . - method returns an to indicate which part of the selection adorner intersects or surrounds a . This is useful when performing drag-and-drop operations. - - -## XAML Text Usage - This class is not typically used in XAML. - - - -## Examples - The following example demonstrates how use to determine whether to create a to initiate drag and drop. To implement drag and drop between two objects, see [How to: Drag and Drop Ink](/dotnet/framework/wpf/advanced/how-to-drag-and-drop-ink). - + method returns an to indicate which part of the selection adorner intersects or surrounds a . This is useful when performing drag-and-drop operations. + + +## XAML Text Usage + This class is not typically used in XAML. + + + +## Examples + The following example demonstrates how use to determine whether to create a to initiate drag and drop. To implement drag and drop between two objects, see [How to: Drag and Drop Ink](/dotnet/framework/wpf/advanced/how-to-drag-and-drop-ink). + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/HitTestSelection/Window1.xaml.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/HitTestSelection/Window1.xaml.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/HitTestSelection/Window1.xaml.vb" id="Snippet3"::: + ]]> diff --git a/xml/System.Windows.Controls/InkCanvasStrokeCollectedEventArgs.xml b/xml/System.Windows.Controls/InkCanvasStrokeCollectedEventArgs.xml index 0d2ca1f752c..8b1851bc65a 100644 --- a/xml/System.Windows.Controls/InkCanvasStrokeCollectedEventArgs.xml +++ b/xml/System.Windows.Controls/InkCanvasStrokeCollectedEventArgs.xml @@ -87,11 +87,11 @@ The event target. Provides a way to invoke event handlers in a type-specific way. - can increase efficiency over the base implementation. - + can increase efficiency over the base implementation. + ]]> diff --git a/xml/System.Windows.Controls/InkPresenter.xml b/xml/System.Windows.Controls/InkPresenter.xml index fb33095f49b..4348161df09 100644 --- a/xml/System.Windows.Controls/InkPresenter.xml +++ b/xml/System.Windows.Controls/InkPresenter.xml @@ -29,7 +29,7 @@ ## Remarks Ink rendering occurs in two ways: dynamic and static. Dynamic rendering occurs as ink is written to an inking surface: the stroke is rendered as it is being collected. Static rendering occurs after stroke data is collected and attached to a new stroke. - To render ink dynamically using the , attach the property of a to the by using the method. To statically render ink, add stroke objects to the property. + To render ink dynamically using the , attach the property of a to the by using the method. To statically render ink, add stroke objects to the property. @@ -142,7 +142,7 @@ ## Examples - The following example demonstrates how to attach the visual and of a to an . + The following example demonstrates how to attach the visual and of a to an . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/StylusControl.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/StylusControl.vb" id="Snippet3"::: @@ -186,7 +186,7 @@ on a custom control changes, the visual of the must be re-attached to the . Call the and methods to re-attach the visual to the . + When the on a custom control changes, the visual of the must be re-attached to the . Call the and methods to re-attach the visual to the . diff --git a/xml/System.Windows.Controls/ItemCollection.xml b/xml/System.Windows.Controls/ItemCollection.xml index 1a082062b2f..e31ae4177b2 100644 --- a/xml/System.Windows.Controls/ItemCollection.xml +++ b/xml/System.Windows.Controls/ItemCollection.xml @@ -71,9 +71,9 @@ ## Remarks maintains a collection of items such as strings, objects, XML nodes, elements, and other collections. An uses the data in the to generate its content. If you want to aggregate more than one collection, assign a to the property of your . - Use either the property or the property to specify the collection that should be used to generate the content of your . When the property is set, the collection will be made read-only and fixed-size. This means that if you are using the property, you cannot add, delete, or change items in the directly. + Use either the property or the property to specify the collection that should be used to generate the content of your . When the property is set, the collection will be made read-only and fixed-size. This means that if you are using the property, you cannot add, delete, or change items in the directly. - is a and therefore provides collection view functionalities, such as sorting, grouping, and filtering. For more information, see , , and . + is a and therefore provides collection view functionalities, such as sorting, grouping, and filtering. For more information, see , , and . For more information about collection views, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -709,7 +709,7 @@ or property. + This method evaluates the index with any sorting, filtering, or grouping criteria that are set on the view using the or property. ]]> diff --git a/xml/System.Windows.Controls/ItemContainerGenerator.xml b/xml/System.Windows.Controls/ItemContainerGenerator.xml index 069749d6897..baf008a7730 100644 --- a/xml/System.Windows.Controls/ItemContainerGenerator.xml +++ b/xml/System.Windows.Controls/ItemContainerGenerator.xml @@ -40,13 +40,13 @@ ## Remarks implements , which is the interface that defines a type which: -- Maintains an association between the data view of a multiple-item control, such as and the corresponding items. +- Maintains an association between the data view of a multiple-item control, such as and the corresponding items. - Generates items on behalf of a multiple-item control. Each type has a corresponding container type. Container elements are the objects that contain the data items in the item collection. For example, for , the generated containers are controls; for , they are controls. - The generates its items through the interface. The property of the is of type , which implements the interface. Therefore, you can access the object associated with your using the property. For example, if you have a data-bound , and you want to get a based on its index or its associated data item, you can use the or the method. Alternatively, you can use the or the method to get the index or data item associated with a given generated container element. + The generates its items through the interface. The property of the is of type , which implements the interface. Therefore, you can access the object associated with your using the property. For example, if you have a data-bound , and you want to get a based on its index or its associated data item, you can use the or the method. Alternatively, you can use the or the method to get the index or data item associated with a given generated container element. Apart from those usages, the interface is used in advanced scenarios. Typically, advanced applications that have their own implementation of a virtualizing panel call members of the interface. @@ -153,7 +153,7 @@ can use this method to get an object that will properly set the generated property. When the method returns, property is set to . When the object is disposed, is set to . You can pass the object to a `using` statement that encapsulates your logic that generates item containers. When the object returned from goes out of scope, the property will be properly set. + A class that inherits from can use this method to get an object that will properly set the generated property. When the method returns, property is set to . When the object is disposed, is set to . You can pass the object to a `using` statement that encapsulates your logic that generates item containers. When the object returned from goes out of scope, the property will be properly set. ]]> @@ -204,7 +204,7 @@ method and passing `false` to the `returnLocalIndex` parameter. + Calling this method is identical to calling the method and passing `false` to the `returnLocalIndex` parameter. ]]> diff --git a/xml/System.Windows.Controls/ItemContainerTemplate.xml b/xml/System.Windows.Controls/ItemContainerTemplate.xml index cb6546ab609..13df9df81ba 100644 --- a/xml/System.Windows.Controls/ItemContainerTemplate.xml +++ b/xml/System.Windows.Controls/ItemContainerTemplate.xml @@ -81,11 +81,11 @@ Gets the default key of the . The default key of the . - that is in a , the is used as the key. - + that is in a , the is used as the key. + ]]> diff --git a/xml/System.Windows.Controls/ItemsControl.xml b/xml/System.Windows.Controls/ItemsControl.xml index 88f63ff307e..2f7072a9d2e 100644 --- a/xml/System.Windows.Controls/ItemsControl.xml +++ b/xml/System.Windows.Controls/ItemsControl.xml @@ -76,11 +76,11 @@ ![ListBox with four types of content](~/add/media/controlcontentmodellistbox2.PNG "ListBox with four types of content") ListBox that contains multiple types of objects - Use either the or the property to specify the collection to use to generate the content of your . You can set the property to any type that implements . is typically used to display a data collection or to bind an to a collection object. + Use either the or the property to specify the collection to use to generate the content of your . You can set the property to any type that implements . is typically used to display a data collection or to bind an to a collection object. If you do not want to use an object that implements to populate the , you can add items by using the property. The items in an can have different types. For example, a can contain one item that is a string and another item that is an . - When the property is set, the collection is set to read-only and fixed-size. This means that you cannot add items to the collection directly. When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . + When the property is set, the collection is set to read-only and fixed-size. This means that you cannot add items to the collection directly. When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . Each type has a corresponding item container type. The corresponding item container for each appends `Item` to its name. For example, for , the item containers are controls; for , they are controls. You can explicitly create a container type for each item in the , but it is not necessary. When you do not explicitly create the container type, one is generated that contains a data item in the item collection. For example, if you bind a collection of string objects to the property of a , you do not explicitly create objects, but the will generate one for each string. You can access a generated item container by using the property. @@ -97,7 +97,7 @@ ListBox that contains multiple types of objects :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ContentControl/Overview/Window1.xaml.vb" id="Snippet8"::: - The following example binds the object of an to `MyData`. + The following example binds the object of an to `MyData`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml" id="Snippet7"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml" id="Snippet6"::: @@ -136,7 +136,7 @@ ListBox that contains multiple types of objects ![ItemsControl example screenshot](~/add/media/databinding-itemscontrolproperties.png "ItemsControl example screenshot") - Two other style-related properties of the that are not shown here are and . + Two other style-related properties of the that are not shown here are and . ]]> @@ -271,9 +271,9 @@ ListBox that contains multiple types of objects and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. + The and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. -|Position of Item in the || +|Position of Item in the || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| |1|0| |2|1| @@ -283,12 +283,12 @@ ListBox that contains multiple types of objects |6|2| |7|0| - There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . + There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . ## Examples - The following example specifies that the (which inherits from ) has alternating item containers (which are of type ) and specifies a different background and foreground for each one. The example binds the and properties to the and provides an for each property. + The following example specifies that the (which inherits from ) has alternating item containers (which are of type ) and specifies a different background and foreground for each one. The example binds the and properties to the and provides an for each property. :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/AlternationCount/Window1.xaml" id="Snippet2"::: @@ -357,9 +357,9 @@ ListBox that contains multiple types of objects and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. + The and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. -|Position of Item in the || +|Position of Item in the || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| |1|0| |2|1| @@ -369,12 +369,12 @@ ListBox that contains multiple types of objects |6|2| |7|0| - There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . + There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . ## Examples - The following example specifies that the (which inherits from ) has alternating item containers (which are of type ) and specifies a different background and foreground for each one. The example binds the and properties to the and provides an for each property. + The following example specifies that the (which inherits from ) has alternating item containers (which are of type ) and specifies a different background and foreground for each one. The example binds the and properties to the and provides an for each property. :::code language="xml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/AlternationCount/Window1.xaml" id="Snippet2"::: @@ -626,7 +626,7 @@ ListBox that contains multiple types of objects :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ItemsControl/DisplayMemberPath/window1.xaml" id="Snippet1"::: - The view can be a binding source, as in the following example. Because of the specified , each`Place` object is shown with its `CityName` value. If is not specified and there is no , then the displays a string representation of each object in the underlying collection (in this case, "SDKSample.Place"). + The view can be a binding source, as in the following example. Because of the specified , each`Place` object is shown with its `CityName` value. If is not specified and there is no , then the displays a string representation of each object in the underlying collection (in this case, "SDKSample.Place"). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ItemsControl/DisplayMemberPath/window1.xaml" id="Snippet2"::: @@ -790,7 +790,7 @@ ListBox that contains multiple types of objects is set to `true` on `element` in a style or if `element` is a panel created by the for an , the is returned; otherwise, `null`. + If is set to `true` on `element` in a style or if `element` is a panel created by the for an , the is returned; otherwise, `null`. ]]> @@ -858,7 +858,7 @@ ListBox that contains multiple types of objects ## Examples The following examples show an that is bound to an and the code-behind content that contains the logic to add and remove grouping. When the check box is checked, the content of the is grouped by the `Type` attribute. - Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. + Each group is of type . The is specified so that it appears as a that displays the of each the group. In this case, the is either `Work` or `Home`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GroupStyle/Overview/Window1.xaml" id="Snippetxaml"::: @@ -1150,7 +1150,7 @@ ListBox that contains multiple types of objects method. + This method calls the method. ]]> @@ -1369,17 +1369,17 @@ ListBox that contains multiple types of objects property, each item container gets a that has the same objects as the , but the properties that describe the data in the bindings, such as and , are specific to the data for each item in the . You must access the item container's to perform operations such as validate the data and check for errors on an item. + When you set the property, each item container gets a that has the same objects as the , but the properties that describe the data in the bindings, such as and , are specific to the data for each item in the . You must access the item container's to perform operations such as validate the data and check for errors on an item. ## Examples - The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer, and then checks that the sales representative and the customer belong to the same region. The example sets the of the so the , `AreasMatch`, will validate each item. The example also creates a that displays validation errors. Notice that the of the is bound to a that it gets from the property. The value of is the item container that has the error. + The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer, and then checks that the sales representative and the customer belong to the same region. The example sets the of the so the , `AreasMatch`, will validate each item. The example also creates a that displays validation errors. Notice that the of the is bound to a that it gets from the property. The value of is the item container that has the error. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetitembindinggroup"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetvalidationadornersitefor"::: - The following example gets the item container and calls on the container's to validate the data. You must validate the data by calling a method on the item container's , not on the of the . + The following example gets the item container and calls on the container's to validate the data. You must validate the data by calling a method on the item container's , not on the of the . :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml.cs" id="Snippetupdatesources"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window2.xaml.vb" id="Snippetupdatesources"::: @@ -1460,7 +1460,7 @@ ListBox that contains multiple types of objects is responsible for generating the user interface (UI) for its host, such as an . It maintains the association between the items in the data view of the control and the corresponding objects. Every has an associated item container that contains a data item in the item collection. You can use the property to access the item container that is associated with your . For example, if you have a data-bound control and you want to get a based on its index or its associated data item, you can use the or the method. Alternatively, you can use the or the method to get the index or data item that is associated with a given generated container element. + An is responsible for generating the user interface (UI) for its host, such as an . It maintains the association between the items in the data view of the control and the corresponding objects. Every has an associated item container that contains a data item in the item collection. You can use the property to access the item container that is associated with your . For example, if you have a data-bound control and you want to get a based on its index or its associated data item, you can use the or the method. Alternatively, you can use the or the method to get the index or data item that is associated with a given generated container element. The interface is also used in advanced scenarios. Typically, advanced applications that have their own implementation of a virtualizing panel call members of the interface. @@ -1511,7 +1511,7 @@ ListBox that contains multiple types of objects ## Remarks You use this property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. - The provides great flexibility for visual customization and provides many styling and templating properties. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. To specify the visualization of data objects, use the or property. For more information about when to specify an , see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). + The provides great flexibility for visual customization and provides many styling and templating properties. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. To specify the visualization of data objects, use the or property. For more information about when to specify an , see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). ## XAML Attribute Usage @@ -1565,7 +1565,7 @@ ListBox that contains multiple types of objects ![ItemsControl example screenshot](~/add/media/databinding-itemscontrolproperties.png "ItemsControl example screenshot") - Two other style-related properties of the that are not shown here are and . + Two other style-related properties of the that are not shown here are and . ]]> @@ -1646,7 +1646,7 @@ ListBox that contains multiple types of objects ## Remarks You use the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. If you have more than one style defined and need to supply logic to choose which one to apply, then you use the property instead of the property. Note that this property is ignored if the property is set. - The provides great flexibility for visual customization and provides many styling and templating properties. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. To specify the visualization of data objects, use the or property. For more information about when to specify an , see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). + The provides great flexibility for visual customization and provides many styling and templating properties. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. To specify the visualization of data objects, use the or property. For more information about when to specify an , see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). ## Dependency Property Information @@ -1733,9 +1733,9 @@ ListBox that contains multiple types of objects > [!NOTE] > This property can only be set in Extensible Application Markup Language (XAML) via the collection syntax shown, or by accessing the collection object and using its various methods such as `Add`. The property to access the collection object itself is read-only, and the collection itself is read-write. - Note that you use either the or the property to specify the collection that should be used to generate the content of your . When the property is set, the collection is made read-only and fixed-size. + Note that you use either the or the property to specify the collection that should be used to generate the content of your . When the property is set, the collection is made read-only and fixed-size. - When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . + When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . ## XAML Property Element Usage @@ -1759,7 +1759,7 @@ ListBox that contains multiple types of objects :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ContentControl/Overview/Window1.xaml.vb" id="Snippet8"::: - The following example binds the object of an to `MyData`. + The following example binds the object of an to `MyData`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml" id="Snippet7"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/Overview/Window1.xaml" id="Snippet6"::: @@ -1887,7 +1887,7 @@ ListBox that contains multiple types of objects To affect the layout of the items in an , you use this property to specify a . - The provides great flexibility for visual customization and provides many styling and templating properties. You use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. If you are using grouping on your control, you can use the or property. To specify the visualization of the data objects, use the or the property. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). + The provides great flexibility for visual customization and provides many styling and templating properties. You use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. If you are using grouping on your control, you can use the or property. To specify the visualization of the data objects, use the or the property. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). ## Dependency Property Information @@ -1904,7 +1904,7 @@ ListBox that contains multiple types of objects :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/Overview/Window1.xaml" id="Snippetitemspanel"::: - The following example uses a to create a horizontal that has rounded corners. In this example, instead of setting the property as in previous example, the horizontal is specified within the . The property is set to `true` on the , indicating that the generated items should go in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, only do this if you know you would not want the panel to be replaced without the use of a template. + The following example uses a to create a horizontal that has rounded corners. In this example, instead of setting the property as in previous example, the horizontal is specified within the . The property is set to `true` on the , indicating that the generated items should go in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, only do this if you know you would not want the panel to be replaced without the use of a template. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/window1.xaml" id="Snippetlistboxct"::: @@ -1988,12 +1988,12 @@ ListBox that contains multiple types of objects A common scenario is to use an such as a , , or to display a data collection, or to bind an to a collection object. To bind an to a collection object, use the property. Note that the property supports binding by default. - When the property is set, the collection is made read-only and fixed-size. + When the property is set, the collection is made read-only and fixed-size. - When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . When is not in use, the value of this property is `null`, and setting it to `null` has no effect. + When is in use, setting the property to `null` removes the collection and restores usage to , which will be an empty . When is not in use, the value of this property is `null`, and setting it to `null` has no effect. > [!NOTE] -> In most cases you do not need to implement your own collections. Instead, consider using or other existing collections. For more information, see the "Collection Objects Used as Binding Source" in [Binding Sources Overview](/dotnet/framework/wpf/data/binding-sources-overview). +> In most cases you do not need to implement your own collections. Instead, consider using or other existing collections. For more information, see the "Collection Objects Used as Binding Source" in [Binding Sources Overview](/dotnet/framework/wpf/data/binding-sources-overview). ## XAML Attribute Usage @@ -2083,12 +2083,12 @@ ListBox that contains multiple types of objects can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or of a , the property is ignored. ## Examples - The following example uses the to specify the format of a list of objects. + The following example uses the to specify the format of a list of objects. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml" id="Snippetitemscontrol"::: @@ -2160,21 +2160,21 @@ ListBox that contains multiple types of objects to specify the visualization of the data objects. If your is bound to a collection object and you do not provide specific display instructions using a , the resulting UI of each item is a string representation of each object in the underlying collection. + You use the to specify the visualization of the data objects. If your is bound to a collection object and you do not provide specific display instructions using a , the resulting UI of each item is a string representation of each object in the underlying collection. - When you set an on an , the UI is generated as follows (using the as an example): + When you set an on an , the UI is generated as follows (using the as an example): -1. During content generation, the initiates a request for the to create a container for each data item. For , the container is a . The generator calls back into the to prepare the container. +1. During content generation, the initiates a request for the to create a container for each data item. For , the container is a . The generator calls back into the to prepare the container. -2. Part of the preparation involves the copying of the of the to be the of the . +2. Part of the preparation involves the copying of the of the to be the of the . -3. Similar to all types, the of a contains a . When the template is applied, it creates a whose is bound to the of the . +3. Similar to all types, the of a contains a . When the template is applied, it creates a whose is bound to the of the . -4. Finally, the applies that to itself, and that creates the UI. +4. Finally, the applies that to itself, and that creates the UI. If you have more than one defined and you want to supply logic to programmatically choose and apply a , use the property. - The provides great flexibility for visual customization and provides many styling and templating properties. Use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. + The provides great flexibility for visual customization and provides many styling and templating properties. Use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). @@ -2294,9 +2294,9 @@ ListBox that contains multiple types of objects to specify the visualization of the data objects. If you have more than one template defined and want to supply logic to return a template to use, then you use this property. Note that this property is ignored if is set. + You use the to specify the visualization of the data objects. If you have more than one template defined and want to supply logic to return a template to use, then you use this property. Note that this property is ignored if is set. - The provides great flexibility for visual customization and provides many styling and templating properties. Use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. + The provides great flexibility for visual customization and provides many styling and templating properties. Use the property or the property to set a style to affect the appearance of the elements that contain the data items. For example, for , the generated containers are controls; for , they are controls. To affect the layout of the items, use the property. If you are using grouping on your control, you can use the or property. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). @@ -2330,14 +2330,14 @@ ListBox that contains multiple types of objects :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ItemsControl/ItemTemplateSelector/Window1.xaml" id="Snippetitemtemplateselector"::: - The following example shows the implementation of the `AuctionItemDataTemplateSelector` class with an override of the method: + The following example shows the implementation of the `AuctionItemDataTemplateSelector` class with an override of the method: :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ItemsControl/ItemTemplateSelector/AuctionItemDataTemplateSelector.cs" id="Snippetdatatemplateselector"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ItemsControl/ItemTemplateSelector/auctionitemdatatemplateselector.vb" id="Snippetdatatemplateselector"::: - In this case, within the method of the class, there is logic to return the appropriate template based on the value of the `SpecialFeatures` property of the `item` object passed. The template to return is found in the resources of the enveloping element. + In this case, within the method of the class, there is logic to return the appropriate template based on the value of the `SpecialFeatures` property of the `item` object passed. The template to return is found in the resources of the enveloping element. - When you set the property, the is directed to automatically call the method of `AuctionItemDataTemplateSelector` for each of the items in the collection to which the is bound. The call passes the data item as an object. The that is returned by the method is then used to display that data item. + When you set the property, the is directed to automatically call the method of `AuctionItemDataTemplateSelector` for each of the items in the collection to which the is bound. The call passes the data item as an object. The that is returned by the method is then used to display that data item. For another example, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). diff --git a/xml/System.Windows.Controls/ItemsPanelTemplate.xml b/xml/System.Windows.Controls/ItemsPanelTemplate.xml index 3b3a22c52aa..45663419431 100644 --- a/xml/System.Windows.Controls/ItemsPanelTemplate.xml +++ b/xml/System.Windows.Controls/ItemsPanelTemplate.xml @@ -29,7 +29,7 @@ ## Remarks The specifies the panel that is used for the layout of items. has a property that is of type . types have an property that is of type . - Each type has a default . For the class, the default value is an that specifies a . For the , the default uses the . For , the default uses . For , the default uses . + Each type has a default . For the class, the default value is an that specifies a . For the , the default uses the . For , the default uses . For , the default uses . @@ -38,7 +38,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentPresenter/Overview/Window1.xaml" id="Snippetitemspanel"::: -The following example uses a to create a horizontal that has rounded corners. Note that in this example, instead of setting the property as in previous example, the horizontal is specified within the . Note that the property is set to `true` on the , indicating that the generated items should go in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, only do this if you know you wouldn't want the panel to be replaced without the use of a template. +The following example uses a to create a horizontal that has rounded corners. Note that in this example, instead of setting the property as in previous example, the horizontal is specified within the . Note that the property is set to `true` on the , indicating that the generated items should go in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, only do this if you know you wouldn't want the panel to be replaced without the use of a template. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/window1.xaml" id="SnippetListBoxCT"::: diff --git a/xml/System.Windows.Controls/KeyTipControl.xml b/xml/System.Windows.Controls/KeyTipControl.xml index 75d5ff66e49..d5f1e8cacf0 100644 --- a/xml/System.Windows.Controls/KeyTipControl.xml +++ b/xml/System.Windows.Controls/KeyTipControl.xml @@ -88,7 +88,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> diff --git a/xml/System.Windows.Controls/Label.xml b/xml/System.Windows.Controls/Label.xml index d444743884e..e346442f808 100644 --- a/xml/System.Windows.Controls/Label.xml +++ b/xml/System.Windows.Controls/Label.xml @@ -166,7 +166,7 @@ an access key and setting this property. Assign an access key to a label by placing an underscore immediately before the character that acts as the access key. An access key can be specified in the property or by setting to an object. + You can provide keyboard shortcuts to elements that don't support access keys by giving a an access key and setting this property. Assign an access key to a label by placing an underscore immediately before the character that acts as the access key. An access key can be specified in the property or by setting to an object. You cannot use this property to define a . For example, the following compiles but is not functional: ``. This property provides a reference to an element that is already defined in your application. diff --git a/xml/System.Windows.Controls/ListBox.xml b/xml/System.Windows.Controls/ListBox.xml index 97436535049..b41eec8569e 100644 --- a/xml/System.Windows.Controls/ListBox.xml +++ b/xml/System.Windows.Controls/ListBox.xml @@ -188,7 +188,7 @@ in its style and has a custom keyboard scrolling behavior, should return `true`. + If the control has a in its style and has a custom keyboard scrolling behavior, should return `true`. ]]> @@ -464,7 +464,7 @@ ## Examples - The following example shows how to use the method to scroll an item in the list box into the viewport. + The following example shows how to use the method to scroll an item in the list box into the viewport. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ListBox/ScrollIntoView/Window1.xaml.cs" id="Snippetlistboxscrollintoview"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ListBox/ScrollIntoView/window1.xaml.vb" id="Snippetlistboxscrollintoview"::: @@ -503,7 +503,7 @@ method to select and highlight all the items in a list box. + The following example shows how to use the method to select and highlight all the items in a list box. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ListBox/ScrollIntoView/Window1.xaml.cs" id="Snippetlistboxselectall"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ListBox/ScrollIntoView/window1.xaml.vb" id="Snippetlistboxselectall"::: @@ -557,7 +557,7 @@ does not equal . If the selection mode is the correct property to use is . + This property is meant to be used when does not equal . If the selection mode is the correct property to use is . ## Dependency Property Information @@ -750,7 +750,7 @@ method to unselect all the items in a list box. + The following example shows how to use the method to unselect all the items in a list box. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ListBox/ScrollIntoView/Window1.xaml.cs" id="Snippetlistboxunselectall"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ListBox/ScrollIntoView/window1.xaml.vb" id="Snippetlistboxunselectall"::: diff --git a/xml/System.Windows.Controls/ListBoxItem.xml b/xml/System.Windows.Controls/ListBoxItem.xml index bfc56cf83b3..9d320577116 100644 --- a/xml/System.Windows.Controls/ListBoxItem.xml +++ b/xml/System.Windows.Controls/ListBoxItem.xml @@ -38,7 +38,7 @@ Bind a to data by binding the property of a to a data source. For more information, see [How to: Bind a ListBox to Data](/dotnet/framework/wpf/controls/how-to-bind-a-listbox-to-data). You can customize the appearance of a by setting the property of a to a . For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the panel's default is applied and the item is centered. + By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the panel's default is applied and the item is centered. A is a , which means that it can contain a single object of any type (such as a string, an image, or a panel). For more information, see the class. @@ -138,7 +138,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/ListView.xml b/xml/System.Windows.Controls/ListView.xml index 25a6f7b12bb..9c3d3b6ab6e 100644 --- a/xml/System.Windows.Controls/ListView.xml +++ b/xml/System.Windows.Controls/ListView.xml @@ -44,13 +44,13 @@ You can also define custom views by creating a class that derives from . For more information, see [How to: Create a Custom View Mode for a ListView](/dotnet/framework/wpf/controls/how-to-create-a-custom-view-mode-for-a-listview). - If you define a custom for a control and also define an , you must include a in the . The is required for the to work correctly. + If you define a custom for a control and also define an , you must include a in the . The is required for the to work correctly. - To avoid alignment issues in a view mode, do not add content or set properties that affect the width of an item in the of a . To prevent alignment issues, use properties and templates that are defined for the view mode. This includes properties and templates that are defined for classes that are used in a view mode, such as and . + To avoid alignment issues in a view mode, do not add content or set properties that affect the width of an item in the of a . To prevent alignment issues, use properties and templates that are defined for the view mode. This includes properties and templates that are defined for classes that are used in a view mode, such as and . Two controls cannot share the same view. To specify a view that can be used more than one time, use templates or styles. - Do not use the and properties for content that is displayed by using a . To specify the alignment of content in a column of a , define a . + Do not use the and properties for content that is displayed by using a . To specify the alignment of content in a column of a , define a . Displaying a large number of items may cause performance issues. See [Optimizing Performance: Controls](/dotnet/framework/wpf/advanced/optimizing-performance-controls) for more information. @@ -62,7 +62,7 @@ [!INCLUDE[setting-a-visual-property](~/includes/visual-property-note.md)] ## Examples - The following example shows how to create a control that implements a as its . The illustration in the Remarks section is taken from this example. + The following example shows how to create a control that implements a as its . The illustration in the Remarks section is taken from this example. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window1.xaml" id="Snippetlistviewemployee"::: @@ -305,7 +305,7 @@ control for display according to the specified . + This method prepares a control for display according to the specified . ]]> @@ -357,7 +357,7 @@ ## Examples - The following example shows how to specify a object as the for a control. + The following example shows how to specify a object as the for a control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window1.xaml.cs" id="Snippetlistviewview"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/GridView/Overview/window1.xaml.vb" id="Snippetlistviewview"::: diff --git a/xml/System.Windows.Controls/MediaElement.xml b/xml/System.Windows.Controls/MediaElement.xml index aceb716333f..1fdc5941730 100644 --- a/xml/System.Windows.Controls/MediaElement.xml +++ b/xml/System.Windows.Controls/MediaElement.xml @@ -40,13 +40,13 @@ ## Remarks When distributing media with your application, you cannot use a media file as a project resource. In your project file, you must instead set the media type to `Content` and set `CopyToOutputDirectory` to `PreserveNewest` or `Always`. - can be used in two different modes, depending on what is driving the control: independent mode or clock mode. When used in the independent mode, the is analogous to an image, and URI can be directly specified. In clock mode, the can be thought of as a target for an animation, and thus it will have corresponding and entries in the timing tree. For more information on media modes, see the [Multimedia Overview](/dotnet/framework/wpf/graphics-multimedia/multimedia-overview). + can be used in two different modes, depending on what is driving the control: independent mode or clock mode. When used in the independent mode, the is analogous to an image, and URI can be directly specified. In clock mode, the can be thought of as a target for an animation, and thus it will have corresponding and entries in the timing tree. For more information on media modes, see the [Multimedia Overview](/dotnet/framework/wpf/graphics-multimedia/multimedia-overview). For an example of controlling a in independent mode, see [How to: Control a MediaElement (Play, Pause, Stop, Volume, and Speed)](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-mediaelement-play-pause-stop-volume-and-speed). - Until the event has been raised, the and of the control will report as zero as the media content is used to determine the final size and location of the control. For audio only content, these properties will always be zero. + Until the event has been raised, the and of the control will report as zero as the media content is used to determine the final size and location of the control. For audio only content, these properties will always be zero. - For a fixed size control, the and/or properties can be set. However, to preserve the media's aspect ratio, set the or properties but not both. + For a fixed size control, the and/or properties can be set. However, to preserve the media's aspect ratio, set the or properties but not both. ]]> @@ -682,7 +682,7 @@ must be set to in order to interactively control media with the , , and methods. + must be set to in order to interactively control media with the , , and methods. ## Dependency Property Information @@ -871,7 +871,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate|, with constraint of .| +|Delegate|, with constraint of .| ]]> @@ -1006,9 +1006,9 @@ . + The value returned is independent of . - is not accurate until the event has been raised. + is not accurate until the event has been raised. ]]> @@ -1044,7 +1044,7 @@ is not accurate until the event has been raised. + is not accurate until the event has been raised. ]]> @@ -1080,7 +1080,7 @@ is not accurate until the event has been raised. + is not accurate until the event has been raised. ]]> @@ -1178,7 +1178,7 @@ method can be used to resume. + This method pauses the media if the media is currently running. The method can be used to resume. This method can be used only when the property is `null`. When the property is non-`null`, the timing engine controls media playback behavior. @@ -1375,7 +1375,7 @@ ## Remarks When set to `false`, seeking to a specific location will only update the displayed frame if media is playing. - Setting to `true` can incur some performance costs, especially when interactively controlling media playback. + Setting to `true` can incur some performance costs, especially when interactively controlling media playback. ## Dependency Property Information @@ -1457,7 +1457,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -1524,7 +1524,7 @@ ## Remarks This property can be set only when the property is `null`. When the property is non-`null`, the timing engine controls media playback behavior. - Audio playback may not occur unless the value of is 1. + Audio playback may not occur unless the value of is 1. ]]> @@ -1611,7 +1611,7 @@ Different gradient spread methods | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1663,7 +1663,7 @@ Different gradient spread methods | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/MenuItem.xml b/xml/System.Windows.Controls/MenuItem.xml index 316b51d9853..f1d34ed2200 100644 --- a/xml/System.Windows.Controls/MenuItem.xml +++ b/xml/System.Windows.Controls/MenuItem.xml @@ -65,9 +65,9 @@ - It can be checked or unchecked. > [!NOTE] -> By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the stack panel's default is applied and the item is centered. +> By default, the of a is set to . The default horizontal position of a is . If you set the property of a through a , the stack panel's default is applied and the item is centered. - The handles the event, so if you attach an event handler to , your handler will never be called. To add your own handler, subscribe to the event or subscribe to by calling with `handledEventsToo` set to `true`. + The handles the event, so if you attach an event handler to , your handler will never be called. To add your own handler, subscribe to the event or subscribe to by calling with `handledEventsToo` set to `true`. ## Customizing the MenuItem Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [Menu Styles and Templates](/dotnet/framework/wpf/controls/menu-styles-and-templates). @@ -77,7 +77,7 @@ [!INCLUDE[setting-a-visual-property](~/includes/visual-property-note.md)] ## Examples - The following example creates a to manipulate text in a . The contains objects that use the , , and properties and the , , and events. + The following example creates a to manipulate text in a . The contains objects that use the , , and properties and the , , and events. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/Overview/Window1.xaml" id="Snippet1"::: @@ -257,7 +257,7 @@ ## Examples - The following example creates a to manipulate text in a . The contains objects that use the , , and properties and the , , and events. + The following example creates a to manipulate text in a . The contains objects that use the , , and properties and the , , and events. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContextMenu/Overview/Window1.xaml" id="Snippet1"::: @@ -347,15 +347,15 @@ instance. The following example associates the **Copy** command with a and automatically supplies the input gesture text **Ctrl+C**. The example does not set the property, but the for the is "Copy" at run time. You can specify another header for the if you want it to be different. For information on how to bind to the desired command, see [Add a Command to a MenuItem](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741839(v=vs.90)). + This property is used to associate a command with a particular instance. The following example associates the **Copy** command with a and automatically supplies the input gesture text **Ctrl+C**. The example does not set the property, but the for the is "Copy" at run time. You can specify another header for the if you want it to be different. For information on how to bind to the desired command, see [Add a Command to a MenuItem](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741839(v=vs.90)). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/MenuItem/Command/Pane11.xaml" id="Snippetmenuitemcommand"::: A command is raised when a is clicked - just after the event. The command is raised on the element according to the following priorities: -1. If is set on the , that element is used. +1. If is set on the , that element is used. -2. The of a that contains the . +2. The of a that contains the . 3. The focus target of the main window that contains a . @@ -535,7 +535,7 @@ property specifies the element where the command occurs. If is not set, the element that has keyboard focus will receive the command. + The property specifies the element where the command occurs. If is not set, the element that has keyboard focus will receive the command. ## Dependency Property Information @@ -638,7 +638,7 @@ in its style and has a custom keyboard scrolling behavior, should return `true`. + If the control has a in its style and has a custom keyboard scrolling behavior, should return `true`. ]]> @@ -765,7 +765,7 @@ . + This property does not associate the input gesture with the menu item; it simply adds text to the menu item. The application must handle the user's input to carry out the action. For information on how to associate a command with a menu item, see . ## Dependency Property Information @@ -954,7 +954,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -1289,7 +1289,7 @@ is set to `true`, mouse capture is set to the and its subtree. + When is set to `true`, mouse capture is set to the and its subtree. ## Dependency Property Information @@ -1297,7 +1297,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1589,7 +1589,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -2149,7 +2149,7 @@ method. + This example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/MenuItem/Command/Pane11.xaml.cs" id="Snippetsubmenueventclosed2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/MenuItem/IsHighlighted/pane1.xaml.vb" id="Snippetsubmenueventclosed2"::: @@ -2191,7 +2191,7 @@ method. + This example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/MenuItem/Command/Pane11.xaml.cs" id="Snippetsubmenueventopened2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/MenuItem/IsHighlighted/pane1.xaml.vb" id="Snippetsubmenueventopened2"::: @@ -2233,7 +2233,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -2351,7 +2351,7 @@ depends on the relationship to the and other objects. + The value of depends on the relationship to the and other objects. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/MenuScrollingVisibilityConverter.xml b/xml/System.Windows.Controls/MenuScrollingVisibilityConverter.xml index 3e938e4c485..ed7e09e58f1 100644 --- a/xml/System.Windows.Controls/MenuScrollingVisibilityConverter.xml +++ b/xml/System.Windows.Controls/MenuScrollingVisibilityConverter.xml @@ -28,20 +28,20 @@ Represents a data-binding converter to handle the visibility of repeat buttons in scrolling menus. - determines whether a menu should display the repeat buttons when a menu has too many items to fit on the screen at once. Use the converter with a that has four bindings. The four bindings should be to properties of the parent : If the menu items are organized vertically (which is the default for menus), bind to , , , and . If the menu items are organized horizontally, bind to , , , and . - - Set to 0 or 100. The value is treated as a percentage and determines whether a button is hidden when the is at the given location. When the is at the top, the position of the is 0% and the top button is hidden. When the is at the bottom, the position of the is 100% and the bottom button is hidden. - -## Examples + determines whether a menu should display the repeat buttons when a menu has too many items to fit on the screen at once. Use the converter with a that has four bindings. The four bindings should be to properties of the parent : If the menu items are organized vertically (which is the default for menus), bind to , , , and . If the menu items are organized horizontally, bind to , , , and . + + Set to 0 or 100. The value is treated as a percentage and determines whether a button is hidden when the is at the given location. When the is at the top, the position of the is 0% and the top button is hidden. When the is at the bottom, the position of the is 100% and the bottom button is hidden. + +## Examples The following example uses the in the of a for a menu. - + For a complete sample, see [Styling with ControlTemplates Sample](https://github.com/dotnet/docs-desktop/tree/main/dotnet-desktop-guide/samples/snippets/csharp/VS_Snippets_Wpf/ControlTemplateExamples/CS). - - :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/menu.xaml" id="Snippetmenuscrollviewer"::: - + + :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/menu.xaml" id="Snippetmenuscrollviewer"::: + ]]> @@ -117,13 +117,13 @@ Called when moving a value from a source to a target. Converted value. - may be returned to indicate that the converter produced no value and that the default value should be used. - - may be returned to indicate that the binding should not transfer the value or use the default value. - + may be returned to indicate that the converter produced no value and that the default value should be used. + + may be returned to indicate that the binding should not transfer the value or use the default value. + ]]> diff --git a/xml/System.Windows.Controls/NotifyDataErrorValidationRule.xml b/xml/System.Windows.Controls/NotifyDataErrorValidationRule.xml index e51cdeb8a71..8766b2c8447 100644 --- a/xml/System.Windows.Controls/NotifyDataErrorValidationRule.xml +++ b/xml/System.Windows.Controls/NotifyDataErrorValidationRule.xml @@ -26,9 +26,9 @@ with a or object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . + The WPF data binding model enables you to associate with a or object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . - An alternative syntax to setting the explicitly is to set the property to `true` on your , , or object. By default, the value of is `true`, so you do not need to explicitly use a . + An alternative syntax to setting the explicitly is to set the property to `true` on your , , or object. By default, the value of is `true`, so you do not need to explicitly use a . You can create a custom rule by creating a class that derives from . For more information and a detailed discussion of data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). diff --git a/xml/System.Windows.Controls/Page.xml b/xml/System.Windows.Controls/Page.xml index ae2a8cfb8ae..4f59b160c44 100644 --- a/xml/System.Windows.Controls/Page.xml +++ b/xml/System.Windows.Controls/Page.xml @@ -40,13 +40,13 @@ ## Remarks encapsulates a page of content that can be navigated, and has the following key members: -- **Lifetime Management**: . +- **Lifetime Management**: . -- **Navigation**: . +- **Navigation**: . -- **Appearance**: , , , , , , , . +- **Appearance**: , , , , , , , . -- **Host Window Appearance**: , , . +- **Host Window Appearance**: , , . A page can be defined by using markup, markup and code-behind, or code. A page is the preferred way to package content for navigation, for the following reasons: @@ -54,7 +54,7 @@ - It can access and use the that navigated to it. -- It can alter the title, width, height, and navigation UI of its host window (, , , ). +- It can alter the title, width, height, and navigation UI of its host window (, , , ). - It has designer support in Microsoft Visual Studio. @@ -66,9 +66,9 @@ - Set as the uniform resource identifier (URI) source of the `Source` property of either or . -- Set as the in a standalone application. +- Set as the in a standalone application. -- Set as the in an XBAP. +- Set as the in an XBAP. An application typically has two or more pages, which can be navigated between using the following mechanisms: @@ -78,7 +78,7 @@ - Visually by using the navigation UI of the host, including a browser, , and . - For structured navigation using page functions (), see [Structured Navigation Overview](/dotnet/framework/wpf/app-development/structured-navigation-overview) and [Navigation Topologies Overview](/dotnet/framework/wpf/app-development/navigation-topologies-overview). + For structured navigation using page functions (), see [Structured Navigation Overview](/dotnet/framework/wpf/app-development/structured-navigation-overview) and [Navigation Topologies Overview](/dotnet/framework/wpf/app-development/navigation-topologies-overview). Dependency properties for this control might be set by the control's default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. @@ -130,7 +130,7 @@ is not being kept alive (see ), it needs to implement a parameterless constructor to allow WPF to create a new instance of it when navigated to in back or forward navigation history. + If a is not being kept alive (see ), it needs to implement a parameterless constructor to allow WPF to create a new instance of it when navigated to in back or forward navigation history. ]]> @@ -212,7 +212,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -369,7 +369,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -404,7 +404,7 @@ dependency property. + The identifier for the dependency property. @@ -463,7 +463,7 @@ . + The font size must be a positive number and in the range of the . ## Dependency Property Information @@ -471,7 +471,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -506,7 +506,7 @@ dependency property. + The identifier for the dependency property. @@ -564,7 +564,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -599,7 +599,7 @@ dependency property. + The identifier for the dependency property. @@ -648,9 +648,9 @@ To keep a page alive, you set the property to `true` (the default is `false`). > [!NOTE] -> Pages that are instantiated and navigated to using only code (for example, calling ), are automatically kept alive. +> Pages that are instantiated and navigated to using only code (for example, calling ), are automatically kept alive. - You should avoid setting to `true` unless you need to: + You should avoid setting to `true` unless you need to: - When a page has a lot of content, it may take a long time to instantiate. If the page is not kept alive, and the page is frequently navigated to, the cost of constantly instantiating the page may have a negative impact on the user experience. However, from a performance perspective, you should rely on the default settings and profile your application's performance; if testing identifies pages with load times that fall below the range required for your application, configuring the pages to be kept alive may be one way to solve the problem. @@ -716,7 +716,7 @@ dependency property. + The identifier for the dependency property. @@ -877,7 +877,7 @@ . + See . ]]> @@ -917,7 +917,7 @@ + ]]> @@ -1160,10 +1160,10 @@ displays navigation UI by default to enable browser-style forwards and backwards navigation. If a page is set as the , automatically opens a to host the page in. If the page does not want to use the default navigation UI, it can set to `false`. + displays navigation UI by default to enable browser-style forwards and backwards navigation. If a page is set as the , automatically opens a to host the page in. If the page does not want to use the default navigation UI, it can set to `false`. > [!NOTE] -> Because WPF does not integrate with the navigation UI for Microsoft Internet Explorer 6, it provides its own navigation UI, which can be shown or hidden by setting . WPF does integrate with the Windows Internet Explorer 7 navigation UI, so setting on pages in Windows Internet Explorer 7 has no effect. +> Because WPF does not integrate with the navigation UI for Microsoft Internet Explorer 6, it provides its own navigation UI, which can be shown or hidden by setting . WPF does integrate with the Windows Internet Explorer 7 navigation UI, so setting on pages in Windows Internet Explorer 7 has no effect. ## Examples The following example shows how to use XAML to hide the navigation UI of a . @@ -1327,7 +1327,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1391,11 +1391,11 @@ property is not displayed by , nor is it displayed from the title bar of the window that is hosting a . Instead, you set to change the title of a host window. + The value of the property is not displayed by , nor is it displayed from the title bar of the window that is hosting a . Instead, you set to change the title of a host window. - can also be used to generate the name of the navigation history entry for a piece of navigated content. The following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: + can also be used to generate the name of the navigation history entry for a piece of navigated content. The following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: -- The attached attribute. +- The attached attribute. - The property. @@ -1403,7 +1403,7 @@ - The uniform resource identifier (URI) for the current page. - If you have associated a object with a piece of content in navigation history, you can specify the name that appears in the navigation history entry by overriding . + If you have associated a object with a piece of content in navigation history, you can specify the name that appears in the navigation history entry by overriding . ## Dependency Property Information @@ -1446,7 +1446,7 @@ dependency property. + The identifier for the dependency property. @@ -1487,19 +1487,19 @@ is only applied when a is hosted directly by a window, which includes: + is only applied when a is hosted directly by a window, which includes: - - - A browser - If a is hosted by a , setting has no effect, but you can still get the value of . + If a is hosted by a , setting has no effect, but you can still get the value of . - A in an XAML browser application (XBAP) can only use to change the height of the browser; the height cannot be changed by setting , , or . + A in an XAML browser application (XBAP) can only use to change the height of the browser; the height cannot be changed by setting , , or . For more information about XBAP support, see [Frequently asked questions about WPF browser-hosted applications (XBAP)](/dotnet/desktop/wpf/app-development/xbap-faq?view=netframeworkdesktop-4.8). - The minimum height of the Windows Internet Explorer window is 150 pixels. For browser-hosted pages, this means that the value of may not be applied if it would cause the total height of the Internet Explorer window to be less than 150 pixels. + The minimum height of the Windows Internet Explorer window is 150 pixels. For browser-hosted pages, this means that the value of may not be applied if it would cause the total height of the Internet Explorer window to be less than 150 pixels. ## Examples The following example shows how to set the height of a window from a page. @@ -1550,14 +1550,14 @@ A page can change the default by setting its property. - Once a page sets the title of a window in this way, the window's title does not change until another page sets with a different value. + Once a page sets the title of a window in this way, the window's title does not change until another page sets with a different value. > [!NOTE] -> The must be the topmost piece of content in a window for to have an effect; if a is hosted within a , for example, setting does not change the title of the host window. +> The must be the topmost piece of content in a window for to have an effect; if a is hosted within a , for example, setting does not change the title of the host window. - can also be used to generate the name of the navigation history entry for a piece of navigated content. The following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: + can also be used to generate the name of the navigation history entry for a piece of navigated content. The following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: -- The attached attribute. +- The attached attribute. - The property. @@ -1565,7 +1565,7 @@ - The uniform resource identifier (URI) for the current page. - If you have associated a object with a piece of content in navigation history, you can specify the name value of a navigation history element by overriding . + If you have associated a object with a piece of content in navigation history, you can specify the name value of a navigation history element by overriding . @@ -1608,19 +1608,19 @@ is only applied when a is hosted directly by a window, which includes: + is only applied when a is hosted directly by a window, which includes: - - - A browser - If a is hosted by a , setting has no effect, but you can still get the value of . + If a is hosted by a , setting has no effect, but you can still get the value of . - A in an XAML browser application (XBAP) can only use to change the width of the browser; the width cannot be changed by setting , , or . + A in an XAML browser application (XBAP) can only use to change the width of the browser; the width cannot be changed by setting , , or . For more information about XBAP support, see [Frequently asked questions about WPF browser-hosted applications (XBAP)](/dotnet/desktop/wpf/app-development/xbap-faq?view=netframeworkdesktop-4.8). - The minimum width of the Windows Internet Explorer window is 250 pixels. For browser-hosted pages, this means that the value of may not be applied if it would cause the total width of the Windows Internet Explorer window to be less than 250 pixels. + The minimum width of the Windows Internet Explorer window is 250 pixels. For browser-hosted pages, this means that the value of may not be applied if it would cause the total width of the Windows Internet Explorer window to be less than 250 pixels. ## Examples The following example shows how to set the width of a window from a page. diff --git a/xml/System.Windows.Controls/PageRange.xml b/xml/System.Windows.Controls/PageRange.xml index 532bac1b97e..84fd55d02fa 100644 --- a/xml/System.Windows.Controls/PageRange.xml +++ b/xml/System.Windows.Controls/PageRange.xml @@ -126,7 +126,7 @@ ## Remarks The `pageFrom` and `PageTo` parameter values are 1-based; page number 1 is the first page. - Since the range includes both the "from" and "to" pages, the total number of pages is " - + 1". + Since the range includes both the "from" and "to" pages, the total number of pages is " - + 1". ]]> @@ -316,7 +316,7 @@ if the two objects are *not* equal; otherwise, . - ]]> + ]]> diff --git a/xml/System.Windows.Controls/Panel.xml b/xml/System.Windows.Controls/Panel.xml index c2e776f1259..8f5cc6a935c 100644 --- a/xml/System.Windows.Controls/Panel.xml +++ b/xml/System.Windows.Controls/Panel.xml @@ -44,9 +44,9 @@ ## Remarks A contains a collection of objects, which are in the property. Adding a child to a implicitly adds it to the for the element. - WPF provides a comprehensive suite of derived implementations, enabling many complex layouts. If you want to implement new layout containers, use the and methods. + WPF provides a comprehensive suite of derived implementations, enabling many complex layouts. If you want to implement new layout containers, use the and methods. - elements do not receive mouse or stylus events if a is not defined. If you need to handle mouse or stylus events but do not want a background for your , use . + elements do not receive mouse or stylus events if a is not defined. If you need to handle mouse or stylus events but do not want a background for your , use . Panel elements do not receive focus by default. To compel a panel element to receive focus, set the property to `true`. @@ -118,7 +118,7 @@ elements do not receive mouse or stylus events if a is not defined. If you need to handle mouse or stylus events but do not want a background for your , use . + elements do not receive mouse or stylus events if a is not defined. If you need to handle mouse or stylus events but do not want a background for your , use . ## Dependency Property Information @@ -126,12 +126,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example sets the of a to a . + The following example sets the of a to a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/Panel/Background/mainwindow.xaml" id="Snippet1"::: @@ -209,9 +209,9 @@ collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. + The collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. - Do not use this collection with derived classes; use the collection instead. + Do not use this collection with derived classes; use the collection instead. This property returns `null` if the is data bound. @@ -444,7 +444,7 @@ ## Remarks The returned collection includes items that are added directly in code, and also items that are generated by data binding. - Classes that are derived from should use this property, instead of the property, for internal overrides such as and . + Classes that are derived from should use this property, instead of the property, for internal overrides such as and . ]]> @@ -499,16 +499,16 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example uses a to create a horizontal . The horizontal is specified within the . The property is set to `true` on the , which indicates that the generated items should be placed in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, do this only if you know that you do not want the panel to be replaced without the use of a template. + The following example uses a to create a horizontal . The horizontal is specified within the . The property is set to `true` on the , which indicates that the generated items should be placed in the panel. When you specify it this way, the cannot be replaced by the user of the control without using a . Therefore, do this only if you know that you do not want the panel to be replaced without the use of a template. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/window1.xaml" id="Snippetlistboxct"::: - Alternatively, you can set the property. The following example sets the in a of a . + Alternatively, you can set the property. The following example sets the in a of a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/Panel/IsItemsHost/window1.xaml" id="Snippet1"::: @@ -606,7 +606,7 @@ can override this property. If is `false`, this property value should be ignored. + Subclasses of can override this property. If is `false`, this property value should be ignored. ]]> @@ -642,7 +642,7 @@ is `false`, this property value should be ignored. + If is `false`, this property value should be ignored. ]]> @@ -750,7 +750,7 @@ values are automatically recalculated when child elements are added to or removed from the collection. + values are automatically recalculated when child elements are added to or removed from the collection. ]]> @@ -795,12 +795,12 @@ ## Remarks The greater the `value` of a given `element`, the more likely the `element` is to appear in the foreground. Likewise, if an `element` has a relatively low `value`, the `element` will likely appear in the background. For example, an `element` that has a `value` of 5 will appear above an `element` that has a `value` of 4, which in turn will appear above an `element` that has a value of 3, and so on. Negative values are allowed, and they continue this precedence pattern. - Members of a collection that have equal values are rendered in the order in which they appear in the visual tree. You can determine the index position of a child by iterating the members of the collection. + Members of a collection that have equal values are rendered in the order in which they appear in the visual tree. You can determine the index position of a child by iterating the members of the collection. ## Examples - The following example demonstrates in code how to set the value of the property (by using the method). + The following example demonstrates in code how to set the value of the property (by using the method). :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/CanvasZ-Order/CPP/CanvasZ-Order.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Panel/SetZIndex/CanvasZ-Order.cs" id="Snippet2"::: @@ -974,7 +974,7 @@ ## Remarks The greater the `value` of a given `element`, the more likely the `element` is to appear in the foreground. Likewise, if an `element` has a relatively low `value`, the `element` will likely appear in the background. For example, an `element` that has a `value` of 5 will appear above an `element` that has a `value` of 4, which in turn will appear above an `element` that has a value of 3, and so on. Negative values are allowed, and they continue this precedence pattern. - Members of a collection that have equal values are rendered in the order in which they appear in the visual tree. You can determine the index position of a child by iterating the members of the collection. + Members of a collection that have equal values are rendered in the order in which they appear in the visual tree. You can determine the index position of a child by iterating the members of the collection. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/PasswordBox.xml b/xml/System.Windows.Controls/PasswordBox.xml index c24a1855ab1..631c0a9147f 100644 --- a/xml/System.Windows.Controls/PasswordBox.xml +++ b/xml/System.Windows.Controls/PasswordBox.xml @@ -36,7 +36,7 @@ ## Remarks > [!IMPORTANT] -> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for `MouseUp` or `MouseDown` events from a `PasswordBox` will never be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. +> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for `MouseUp` or `MouseDown` events from a `PasswordBox` will never be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. ## Customizing the PasswordBox Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [PasswordBox Styles and Templates](/dotnet/framework/wpf/controls/passwordbox-styles-and-templates). @@ -114,12 +114,12 @@ property of a to specify the color of its caret. For example, you can set to be the same value as the property. indicates the color of the characters in the . + You can set the property of a to specify the color of its caret. For example, you can set to be the same value as the property. indicates the color of the characters in the . ## Examples - The following example creates a and sets the and to red. + The following example creates a and sets the and to red. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/CaretBrush/window1.xaml" id="Snippetpasswordbox"::: @@ -194,7 +194,7 @@ PasswordBox with CaretBrush set to red ## Examples - The following example shows how to clear a with the method. + The following example shows how to clear a with the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/Overview/Window1.xaml.cs" id="Snippet_pwdbox_clear"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/PasswordBox/Overview/window1.xaml.vb" id="Snippet_pwdbox_clear"::: @@ -400,7 +400,7 @@ PasswordBox with CaretBrush set to red ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/Overview/Window1.xaml" id="Snippet_pwbox_pwchangedxaml"::: @@ -471,7 +471,7 @@ PasswordBox with CaretBrush set to red . + Overrides . ]]> @@ -1317,7 +1317,7 @@ PasswordBox with CaretBrush set to red ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/Overview/Window1.xaml" id="Snippet_pwbox_pwchangedxaml"::: @@ -1393,7 +1393,7 @@ PasswordBox with CaretBrush set to red ## Examples - The following example shows how to paste content into a with the method. + The following example shows how to paste content into a with the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/PasswordBox/Overview/Window1.xaml.cs" id="Snippet_pwdbox_paste"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/PasswordBox/Overview/window1.xaml.vb" id="Snippet_pwdbox_paste"::: @@ -1504,7 +1504,7 @@ PasswordBox with CaretBrush set to red and properties. + You can specify the brush that highlights selected text by setting the and properties. @@ -1578,7 +1578,7 @@ Selected text in a PasswordBox with SelectionBrush set to green to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. + If you set the to 0, the is transparent and is not visible. If you set the to 1.0 or greater, the is opaque and the selected text is not visible. diff --git a/xml/System.Windows.Controls/PrintDialog.xml b/xml/System.Windows.Controls/PrintDialog.xml index 4f3a4555acb..068ef1e143c 100644 --- a/xml/System.Windows.Controls/PrintDialog.xml +++ b/xml/System.Windows.Controls/PrintDialog.xml @@ -29,7 +29,7 @@ ## Remarks A user can use the **Print** dialog box to select a printer, configure it, and perform a print job. - Strictly speaking, you can use the method without ever opening the dialog. In that sense, the control can be used as an unseen printing component. But for performance reasons, it would be better to use either the method or one of the many and methods of the . For more about this, see [How to: Programmatically Print XPS Files](/dotnet/framework/wpf/advanced/how-to-programmatically-print-xps-files). + Strictly speaking, you can use the method without ever opening the dialog. In that sense, the control can be used as an unseen printing component. But for performance reasons, it would be better to use either the method or one of the many and methods of the . For more about this, see [How to: Programmatically Print XPS Files](/dotnet/framework/wpf/advanced/how-to-programmatically-print-xps-files). Do not confuse this class, , with . The latter is used with Windows Forms applications. is used with Windows Presentation Foundation applications. @@ -145,7 +145,7 @@ and values will get an error message advising them of the maximum and minimum page numbers. Nothing will be printed. + Users who click **Print** when the **Print** dialog box is set to print pages outside the range that is set by the and values will get an error message advising them of the maximum and minimum page numbers. Nothing will be printed. ]]> @@ -188,7 +188,7 @@ and values will get an error message advising them of the maximum and minimum page numbers. Nothing will be printed. + Users who click **Print** when the **Print** dialog box is set to print pages outside the range that is set by the and values will get an error message advising them of the maximum and minimum page numbers. Nothing will be printed. ]]> @@ -493,7 +493,7 @@ . To validate it use . + Neither setting nor getting this property validates the . To validate it use . ]]> @@ -608,7 +608,7 @@ method in code. + The following example shows how to use the method in code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/PageRangeSelection/Overview/Window1.xaml.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/PageRangeSelection/Overview/window1.xaml.vb" id="Snippet1"::: diff --git a/xml/System.Windows.Controls/ProgressBar.xml b/xml/System.Windows.Controls/ProgressBar.xml index 60906946829..f0dd7cfbe08 100644 --- a/xml/System.Windows.Controls/ProgressBar.xml +++ b/xml/System.Windows.Controls/ProgressBar.xml @@ -367,7 +367,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/RadioButton.xml b/xml/System.Windows.Controls/RadioButton.xml index 8ee241ae407..25bbf954c86 100644 --- a/xml/System.Windows.Controls/RadioButton.xml +++ b/xml/System.Windows.Controls/RadioButton.xml @@ -135,7 +135,7 @@ controls have the same , a user can select only one at a time. + When two or more controls have the same , a user can select only one at a time. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/RichTextBox.xml b/xml/System.Windows.Controls/RichTextBox.xml index 949a52f0429..8d58ed1b0b4 100644 --- a/xml/System.Windows.Controls/RichTextBox.xml +++ b/xml/System.Windows.Controls/RichTextBox.xml @@ -45,7 +45,7 @@ is the only supported child element for a . > [!IMPORTANT] -> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for `MouseUp` or `MouseDown` events from a will never be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. +> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for `MouseUp` or `MouseDown` events from a will never be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. While supports copying and pasting of images, certain scenarios are currently unsupported and may not work properly. The following table summarizes these scenarios and expected results. @@ -58,9 +58,9 @@ Pasting HTML content into a might result in unexpected behavior because uses RTF format rather than directly using HTML format. - Text always wraps in a . If you do not want text to wrap then set the on the to be larger than the width of the . However, once the page width is reached the text still wraps. + Text always wraps in a . If you do not want text to wrap then set the on the to be larger than the width of the . However, once the page width is reached the text still wraps. - Horizontally and vertically aligning content within a is done with the and properties. Aligning the within the layout of the page is done with the and properties. + Horizontally and vertically aligning content within a is done with the and properties. Aligning the within the layout of the page is done with the and properties. Scrollbars are not visible on a by default. To make a scrollbar visible, set the property to or . @@ -466,7 +466,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -570,7 +570,7 @@ . + This method overrides . ]]> @@ -607,7 +607,7 @@ . + This method overrides . ]]> @@ -678,7 +678,7 @@ method to programmatically select content. + Use the method to programmatically select content. diff --git a/xml/System.Windows.Controls/RowDefinition.xml b/xml/System.Windows.Controls/RowDefinition.xml index f97b3b677d0..94f26048fd4 100644 --- a/xml/System.Windows.Controls/RowDefinition.xml +++ b/xml/System.Windows.Controls/RowDefinition.xml @@ -93,9 +93,9 @@ value takes precedence over the value, which in turn takes precedence over the value. + When you use these values in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ]]> @@ -133,9 +133,9 @@ ## Remarks The default is . - When you use these values in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. + When you use these values in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ## Dependency Property Information @@ -213,9 +213,9 @@ value takes precedence over the value, which in turn takes precedence over the value. + When you use these values in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ## XAML Attribute Usage @@ -330,9 +330,9 @@ value takes precedence over the value, which in turn takes precedence over the value. + When you use these values in the same code example, the value takes precedence over the value, which in turn takes precedence over the value. - When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. + When you add or remove rows or columns, the for all elements and the of all elements becomes zero until is called. ## XAML Attribute Usage diff --git a/xml/System.Windows.Controls/RowDefinitionCollection.xml b/xml/System.Windows.Controls/RowDefinitionCollection.xml index 8e8fe9c5d7f..a250d43e8c9 100644 --- a/xml/System.Windows.Controls/RowDefinitionCollection.xml +++ b/xml/System.Windows.Controls/RowDefinitionCollection.xml @@ -90,7 +90,7 @@ method to add a to a . + The following example demonstrates how to use the method to add a to a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet3"::: @@ -136,7 +136,7 @@ method to clear the content of a . + The following example demonstrates how to use the method to clear the content of a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet4"::: @@ -186,7 +186,7 @@ method to determine whether a exists in a . + The following example demonstrates how to use the method to determine whether a exists in a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet8"::: @@ -347,7 +347,7 @@ method to determine the index position of a within a . + The following example demonstrates how to use the method to determine the index position of a within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet9"::: @@ -402,7 +402,7 @@ ## Examples - The following example demonstrates how to use the method to insert a to a specific `index` position within a . + The following example demonstrates how to use the method to insert a to a specific `index` position within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet9"::: @@ -629,7 +629,7 @@ ## Examples - The following example demonstrates how to use the method to remove a to a at a specific `index` position. + The following example demonstrates how to use the method to remove a to a at a specific `index` position. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet5"::: @@ -681,7 +681,7 @@ ## Examples - The following example demonstrates how to use the method to remove a range of elements from a . + The following example demonstrates how to use the method to remove a range of elements from a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ColumnDefinitionCollection/Add/Window1.xaml.vb" id="Snippet6"::: @@ -766,7 +766,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Controls/ScrollBarVisibility.xml b/xml/System.Windows.Controls/ScrollBarVisibility.xml index 2281a518aed..f3717dbf0a3 100644 --- a/xml/System.Windows.Controls/ScrollBarVisibility.xml +++ b/xml/System.Windows.Controls/ScrollBarVisibility.xml @@ -26,11 +26,11 @@ and property values of the control. + Use this enumeration to set the and property values of the control. The member values of this enumeration specify visibility in a given direction. These member values also specify whether the corresponding dimension is applied to its enclosed content. - When you apply the or to content, you set the viewport size for the content. + When you apply the or to content, you set the viewport size for the content. diff --git a/xml/System.Windows.Controls/ScrollContentPresenter.xml b/xml/System.Windows.Controls/ScrollContentPresenter.xml index 9af8726243b..2a45cf47763 100644 --- a/xml/System.Windows.Controls/ScrollContentPresenter.xml +++ b/xml/System.Windows.Controls/ScrollContentPresenter.xml @@ -461,7 +461,7 @@ minus the . + Valid values are between zero and the minus the . ]]> diff --git a/xml/System.Windows.Controls/ScrollViewer.xml b/xml/System.Windows.Controls/ScrollViewer.xml index 0a17a002ccf..eca0b8643ee 100644 --- a/xml/System.Windows.Controls/ScrollViewer.xml +++ b/xml/System.Windows.Controls/ScrollViewer.xml @@ -54,7 +54,7 @@ Physical scrolling is used to scroll content by a predetermined physical increment, typically by a value that is declared in pixels. Logical scrolling is used to scroll to the next item in the logical tree. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. Physical scrolling is the default scroll behavior for most elements. - If your contains a large number of items, the scrolling performance may be affected. In this case, set to `true`. This causes the content view to remain static while dragging the and to update only when the is released. + If your contains a large number of items, the scrolling performance may be affected. In this case, set to `true`. This causes the content view to remain static while dragging the and to update only when the is released. Because the scroll bars for a element are defined in the default style of the element, scroll bars will no longer appear if you apply a custom style to a . Scroll bars must be defined in the custom style for them to appear. @@ -169,7 +169,7 @@ can be scrolled in terms of physical units or logical units. Physical units are device independent pixels. Logical units are used for scrolling items within an . The default behavior of the is to use physical units to scroll its content. However, in cases where the is set to `true`, the content could use logical units to scroll. For example, , , and other controls that inherit from use logical units to scroll. If is `true`, the values of the , , , and properties are number of items, instead of physical units. + Content in a can be scrolled in terms of physical units or logical units. Physical units are device independent pixels. Logical units are used for scrolling items within an . The default behavior of the is to use physical units to scroll its content. However, in cases where the is set to `true`, the content could use logical units to scroll. For example, , , and other controls that inherit from use logical units to scroll. If is `true`, the values of the , , , and properties are number of items, instead of physical units. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. Physical scrolling is the default scroll behavior for most elements. @@ -410,9 +410,9 @@ is `true`, the content is scrolled when the user releases the of the . When the user drags the , the value does not change. When the user releases the , updates to the current value. + When is `true`, the content is scrolled when the user releases the of the . When the user drags the , the value does not change. When the user releases the , updates to the current value. - When is `false`, the content is scrolled when the user drags the . In this case, is always equal to . + When is `false`, the content is scrolled when the user drags the . In this case, is always equal to . ]]> @@ -476,9 +476,9 @@ is `true`, the content is scrolled when the user releases the of the . When the user drags the , the does not change. When the user releases the , updates to the current value. + When is `true`, the content is scrolled when the user releases the of the . When the user drags the , the does not change. When the user releases the , updates to the current value. - When is `false`, the content is scrolled when the user drags the . In this case, is always equal to . + When is `false`, the content is scrolled when the user drags the . In this case, is always equal to . ]]> @@ -552,9 +552,9 @@ is only an output property; it can effectively be set by specifying the of the content element. + is only an output property; it can effectively be set by specifying the of the content element. - If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. + If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. ## Dependency Property Information @@ -637,7 +637,7 @@ is only an output property; it can effectively be set by specifying the of the content element. + is only an output property; it can effectively be set by specifying the of the content element. The returned value is described in Device Independent Pixels. @@ -717,7 +717,7 @@ + ]]> @@ -1025,13 +1025,13 @@ value corresponds to the content being offset to the left. + A positive value corresponds to the content being offset to the left. - Valid values are between zero and . + Valid values are between zero and . The returned value is described in Device Independent Pixels. - Beginning in the .NET Framework version 3.5 SP1, when is `true`, continues to change as the user drags the , but the content view doesn't change until the is released. In this case, represents the visible content offset and represents the content offset based on the position. + Beginning in the .NET Framework version 3.5 SP1, when is `true`, continues to change as the user drags the , but the content view doesn't change until the is released. In this case, represents the visible content offset and represents the content offset based on the position. ## Dependency Property Information @@ -1122,7 +1122,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1304,7 +1304,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -1348,7 +1348,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -1392,7 +1392,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -1436,7 +1436,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -1626,7 +1626,7 @@ method sets the property to `true`. + The method sets the property to `true`. ]]> @@ -1664,7 +1664,7 @@ method sets the property to `true`. + The method sets the property to `true`. ]]> @@ -1702,7 +1702,7 @@ method sets the property to `true`. + The method sets the property to `true`. ]]> @@ -1740,7 +1740,7 @@ method sets the property to `true`. + The method sets the property to `true`. ]]> @@ -1923,7 +1923,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -1967,7 +1967,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2011,7 +2011,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2055,7 +2055,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. ]]> @@ -2154,16 +2154,16 @@ ## Remarks The property specifies whether the scroll horizontally, vertically, or both. The will scroll when a user drags a finger on the control on a touch device that supports Windows Touch. - can be either set directly on a or used as an attached property. When a control contains a in its , use as an attached property to specify the behavior of the in the . When you use a outside of a , set directly on the . + can be either set directly on a or used as an attached property. When a control contains a in its , use as an attached property to specify the behavior of the in the . When you use a outside of a , set directly on the . ## Examples - The following example creates a and adds several elements to it. In this example, when the size of the window changes, the size of `textblock1` also changes. When the is too small to display all of the content, the becomes scrollable. The example sets to so that the user can scroll the horizontally and vertically by using a finger. + The following example creates a and adds several elements to it. In this example, when the size of the window changes, the size of `textblock1` also changes. When the is too small to display all of the content, the becomes scrollable. The example sets to so that the user can scroll the horizontally and vertically by using a finger. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ScrollViewer/PanningMode/mainwindow.xaml" id="Snippetpanningmodedirect"::: - The following example creates a and uses as an attached property. By default the in the of a has its to . This is so that when the user moves a finger horizontally before moving it vertically, the user highlights text. The example sets to so that the user cannot select text by using a finger. Note that setting to also prevents the user from selecting text. The example sets the property to , so horizontal scrolling is not necessary. + The following example creates a and uses as an attached property. By default the in the of a has its to . This is so that when the user moves a finger horizontally before moving it vertically, the user highlights text. The example sets to so that the user cannot select text by using a finger. Note that setting to also prevents the user from selecting text. The example sets the property to , so horizontal scrolling is not necessary. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ScrollViewer/PanningMode/mainwindow.xaml" id="Snippetpanningmodeattached"::: @@ -2227,7 +2227,7 @@ uses that manipulation to scroll. The property specifies how much the scrolls for each unit of translation. For example, if is 2, the will scroll 2 device-independent units (1/96th inch per unit) for every device-independent unit (1/96th inch) of the translate manipulation. + When a user drags a finger across an object, it is considered a translate manipulation. The uses that manipulation to scroll. The property specifies how much the scrolls for each unit of translation. For example, if is 2, the will scroll 2 device-independent units (1/96th inch per unit) for every device-independent unit (1/96th inch) of the translate manipulation. ]]> @@ -2290,7 +2290,7 @@ is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. + If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. ## Dependency Property Information @@ -2555,7 +2555,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2595,7 +2595,7 @@ ## Remarks This method scrolls to both the vertical and horizontal end points of the content. - This method does not induce any scrolling behavior if is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2633,7 +2633,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2709,7 +2709,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2753,7 +2753,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -2797,7 +2797,7 @@ is `null`. + This method does not induce any scrolling behavior if is `null`. Logical scrolling is used to scroll to the next element in the logical tree. This differs from physical scrolling, which scrolls content by a defined physical increment in a given direction. If you require physical scrolling instead of logical scrolling, wrap the host element in a and set its property to `false`. @@ -3116,13 +3116,13 @@ value corresponds to the content being offset to the top. + A positive value corresponds to the content being offset to the top. - Valid values are between zero and . + Valid values are between zero and . - If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. + If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. - Beginning in the .NET Framework version 3.5 SP1, when is `true`, continues to change as the user drags the , but the content view doesn't change until the is released. In this case, represents the visible content offset and represents the content offset based on the position. + Beginning in the .NET Framework version 3.5 SP1, when is `true`, continues to change as the user drags the , but the content view doesn't change until the is released. In this case, represents the visible content offset and represents the content offset based on the position. ## Dependency Property Information @@ -3212,7 +3212,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3290,9 +3290,9 @@ ## Remarks The viewport is the visible area of the content. - is only an output property; it can effectively be set by specifying the of the content element. + is only an output property; it can effectively be set by specifying the of the content element. - If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. + If is `true`, the values of the , , , and properties are number of items. If is `false`, the values of these properties are Device Independent Pixels. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/SelectedDatesCollection.xml b/xml/System.Windows.Controls/SelectedDatesCollection.xml index 686c028252f..2f3e8025cbd 100644 --- a/xml/System.Windows.Controls/SelectedDatesCollection.xml +++ b/xml/System.Windows.Controls/SelectedDatesCollection.xml @@ -33,10 +33,10 @@ |CalendarSelectionMode|Effect on SelectedDates| |---------------------------|-----------------------------| -||No selections are allowed. cannot be set and no values can be added to .| -||Only a single date can be selected, either by setting or the first value in . cannot be used.| -||A single range of dates can be selected. Setting , adding a date individually to , or using will clear all previous values from .| -||Multiple non-contiguous ranges of dates can be selected. Adding a date individually to or using will not clear . Setting will still clear , but additional dates or ranges can then be added. Adding a range that includes some dates that are already selected or overlaps with another range results in the union of the ranges and does not cause an exception.| +||No selections are allowed. cannot be set and no values can be added to .| +||Only a single date can be selected, either by setting or the first value in . cannot be used.| +||A single range of dates can be selected. Setting , adding a date individually to , or using will clear all previous values from .| +||Multiple non-contiguous ranges of dates can be selected. Adding a date individually to or using will not clear . Setting will still clear , but additional dates or ranges can then be added. Adding a range that includes some dates that are already selected or overlaps with another range results in the union of the ranges and does not cause an exception.| diff --git a/xml/System.Windows.Controls/Slider.xml b/xml/System.Windows.Controls/Slider.xml index da4f2d9ab2d..6f4acaa67bf 100644 --- a/xml/System.Windows.Controls/Slider.xml +++ b/xml/System.Windows.Controls/Slider.xml @@ -83,13 +83,13 @@ [!INCLUDE[setting-a-visual-property](~/includes/visual-property-note.md)] ## Examples - The following examples shows how to bind the property of a to the of a control. + The following examples shows how to bind the property of a to the of a control. - The following example defines a control that is named `RectangleHeight` that can have a between 0 and 200. + The following example defines a control that is named `RectangleHeight` that can have a between 0 and 200. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/Slider/Overview/Pane1.xaml" id="Snippetminimum"::: - The following example shows how to define a that binds its property to the of the control. (In the complete sample, a similar binding is created for the property.) + The following example shows how to define a that binds its property to the of the control. (In the complete sample, a similar binding is created for the property.) :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/Slider/Overview/Pane1.xaml" id="Snippetbindingrectangle"::: @@ -257,7 +257,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -357,7 +357,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -542,7 +542,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -727,7 +727,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -774,7 +774,7 @@ . For example, when you move the control up on a vertical when the property is set to `false`, the of the increases. If the value of the property is changed to `true`, the of the decreases as the moves up. + The value of this property determines the direction of increasing value of a . For example, when you move the control up on a vertical when the property is set to `false`, the of the increases. If the value of the property is changed to `true`, the of the decreases as the moves up. This property binds to the property for the control that it implements. @@ -828,7 +828,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -875,9 +875,9 @@ away from the , the moves in the direction of the mouse click. Instead of moving immediately to the mouse click location, the moves a distance that is defined by the property for each mouse click. + When this property is set to `false` and a mouse click occurs along the away from the , the moves in the direction of the mouse click. Instead of moving immediately to the mouse click location, the moves a distance that is defined by the property for each mouse click. - The effect of multiple mouse clicks can be emulated by pressing and holding the left mouse button until the is repositioned to the desired location. + The effect of multiple mouse clicks can be emulated by pressing and holding the left mouse button until the is repositioned to the desired location. ## Dependency Property Information @@ -929,7 +929,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -976,7 +976,7 @@ and properties define a selection range and must be set for the selection range to appear when is set to `true`. + The and properties define a selection range and must be set for the selection range to appear when is set to `true`. The following illustration shows a with a selection range defined. @@ -1038,7 +1038,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1085,7 +1085,7 @@ is changed and the property is set to `true`, the is automatically moved to the closest tick mark. + When the position of a is changed and the property is set to `true`, the is automatically moved to the closest tick mark. ## Dependency Property Information @@ -1137,7 +1137,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1322,7 +1322,7 @@ of the by and moves the to reflect the change. + This method decreases the of the by and moves the to reflect the change. ]]> @@ -1358,7 +1358,7 @@ of the by and moves the to reflect the change. + This method decreases the of the by and moves the to reflect the change. ]]> @@ -1394,7 +1394,7 @@ of the by and moves the to reflect the change. + This method increases the of the by and moves the to reflect the change. ]]> @@ -1430,7 +1430,7 @@ of the by and moves the to reflect the change. + This method increases the of the by and moves the to reflect the change. ]]> @@ -1466,7 +1466,7 @@ of the to and moves the to reflect the change. + This method changes the of the to and moves the to reflect the change. ]]> @@ -1507,7 +1507,7 @@ value is less than the value, this implementation sets the value to the value. If the new value is less than the value, the value is set to the value. + If the new value is less than the value, this implementation sets the value to the value. If the new value is less than the value, the value is set to the value. ]]> @@ -1543,7 +1543,7 @@ of the to and moves the to reflect the change. + This method changes the of the to and moves the to reflect the change. ]]> @@ -1584,7 +1584,7 @@ value is greater than or equal to the new value. If the value is less than the value, the value is set to the value. The value is also checked to make sure that it is greater than or equal to the value. + This implementation makes sure that the value is greater than or equal to the new value. If the value is less than the value, the value is set to the value. The value is also checked to make sure that it is greater than or equal to the value. ]]> @@ -1623,7 +1623,7 @@ property is `true`, this implementation moves the to the location of the mouse click. + When the property is `true`, this implementation moves the to the location of the mouse click. This implementation marks the event as handled by setting the property of the event data to `true`. The event is handled by this method so that the controls of the do not handle the event. @@ -1751,7 +1751,7 @@ event, this implementation displays a tooltip that shows the of the when the property is not set to . + In addition to the default processing of the event, this implementation displays a tooltip that shows the of the when the property is not set to . This implementation does not handle the event. The value of the property of the is not changed. @@ -1877,7 +1877,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -1923,7 +1923,7 @@ property cannot be greater than the value of the property and cannot be less than the value of the property. The value of the property must also be greater than or equal to the value of the property. If the value of the property is greater than the value of the property or less than the value of the property, the value is set to the value of the or property respectively. + The value of the property cannot be greater than the value of the property and cannot be less than the value of the property. The value of the property must also be greater than or equal to the value of the property. If the value of the property is greater than the value of the property or less than the value of the property, the value is set to the value of the or property respectively. ## Dependency Property Information @@ -1931,7 +1931,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier Field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1977,7 +1977,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -2023,7 +2023,7 @@ property cannot be less than the value of the property and cannot be greater than the value of the property. The value of the property must also be greater than or equal to the value of the property. If is less than or greater than , is set to the value of or respectively. + The value of the property cannot be less than the value of the property and cannot be greater than the value of the property. The value of the property must also be greater than or equal to the value of the property. If is less than or greater than , is set to the value of or respectively. ## Dependency Property Information @@ -2031,7 +2031,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier Field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -2077,7 +2077,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -2180,7 +2180,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -2271,7 +2271,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -2317,7 +2317,7 @@ and property values are ignored. + Tick marks that are outside the range that is defined by the and property values are ignored. The property must be set to a value other than for tick marks to appear. @@ -2371,7 +2371,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls/SoundPlayerAction.xml b/xml/System.Windows.Controls/SoundPlayerAction.xml index 58255113d38..ac5c0d50ee2 100644 --- a/xml/System.Windows.Controls/SoundPlayerAction.xml +++ b/xml/System.Windows.Controls/SoundPlayerAction.xml @@ -110,9 +110,9 @@ is called, the object is no longer valid. + After is called, the object is no longer valid. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -158,14 +158,14 @@ For more information on pack URIs, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). For more information on resource, content, and site of origin files, see [WPF Application Resource, Content, and Data Files](/dotnet/framework/wpf/app-development/wpf-application-resource-content-and-data-files). - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Dependency Property Information | Item | Value | |-----------------------------------|--------------------------------------------------------| -|Identifier Field|| +|Identifier Field|| |Metadata properties set to `true`|None| ]]> diff --git a/xml/System.Windows.Controls/SpellCheck.xml b/xml/System.Windows.Controls/SpellCheck.xml index d2f853931a4..6211075028f 100644 --- a/xml/System.Windows.Controls/SpellCheck.xml +++ b/xml/System.Windows.Controls/SpellCheck.xml @@ -31,7 +31,7 @@ ![Textbox with spell-checking](~/add/media/editing-textbox-with-spellchecking.png "Textbox with spell-checking") - To add a custom dictionary, add the location of the lexicon file to the collection. + To add a custom dictionary, add the location of the lexicon file to the collection. ]]> @@ -75,10 +75,10 @@ TextBox ListBox ``` - To specify one or more custom dictionaries for a or for any class that derives from , specify the location of the lexicon file by adding the URI for the file to the collection. + To specify one or more custom dictionaries for a or for any class that derives from , specify the location of the lexicon file by adding the URI for the file to the collection. > [!NOTE] -> Using to add a file to the collection causes an exception. Instead, use and to update the collection. +> Using to add a file to the collection causes an exception. Instead, use and to update the collection. The lexicon files can be included in the application as content files installed on the local computer or as resource files compiled into a local referenced assembly. You can reference the file by using pack URIs. For more information, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). @@ -175,7 +175,7 @@ TextBox ListBox ``` - To specify one or more custom dictionaries for a or any class that derives from , specify the location of the lexicon file by adding the URI for the file to the returned by the method. + To specify one or more custom dictionaries for a or any class that derives from , specify the location of the lexicon file by adding the URI for the file to the returned by the method. To enable the spelling checker, set the property to `true` on a or on any class that derives from . All custom dictionaries for that are used in addition to the default spelling checker. For more information about the spelling checker, see . @@ -253,7 +253,7 @@ ListBox `, where *textBoxBaseClass* is an object element for a class that derives from , and *boolValue* is either `true` or `false` (case insensitive). To set the property as an attached property in code, see the method. There is no matching `GetIsEnabled` accessor. To get the value, get the current object from the property, and then get the value of the property from that . + This dependency property also has a specialized write-only attached property usage. The XAML syntax for setting the property is `<`*textBoxBaseClass* **SpellCheck.IsEnabled**`="`*boolValue*`" .../>`, where *textBoxBaseClass* is an object element for a class that derives from , and *boolValue* is either `true` or `false` (case insensitive). To set the property as an attached property in code, see the method. There is no matching `GetIsEnabled` accessor. To get the value, get the current object from the property, and then get the value of the property from that . ## Dependency Property Information @@ -411,7 +411,7 @@ ListBox ## Remarks The spelling reform rules that are determined by this property refer to the French and German spelling reforms. This property has no effect when it is used with any other language. - This dependency property also has a specialized write-only attached property usage. The XAML syntax for setting the property is `<`*textBoxBaseClass* **SpellCheck.SpellingReform**`="`*enumValue*`" .../>`, where *textBoxBaseClass* is an object element for a class that derives from , and *enumValue* is a string name for a value of the enumeration. To set the property as an attached property in code, see the method. There is no matching `GetSpellingReform` accessor. To get the value, get the current object from the property, and then get the value of the property from that . + This dependency property also has a specialized write-only attached property usage. The XAML syntax for setting the property is `<`*textBoxBaseClass* **SpellCheck.SpellingReform**`="`*enumValue*`" .../>`, where *textBoxBaseClass* is an object element for a class that derives from , and *enumValue* is a string name for a value of the enumeration. To set the property as an attached property in code, see the method. There is no matching `GetSpellingReform` accessor. To get the value, get the current object from the property, and then get the value of the property from that . ## Dependency Property Information diff --git a/xml/System.Windows.Controls/StackPanel.xml b/xml/System.Windows.Controls/StackPanel.xml index ac2b2ea046c..cc79ed474d1 100644 --- a/xml/System.Windows.Controls/StackPanel.xml +++ b/xml/System.Windows.Controls/StackPanel.xml @@ -34,7 +34,7 @@ ## Remarks A contains a collection of objects, which are in the property. - The default value is stretch for both and of content that is contained in a . + The default value is stretch for both and of content that is contained in a . Panel elements do not receive focus by default. To compel a panel element to receive focus, set the property to `true`. @@ -825,7 +825,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1066,7 +1066,7 @@ control is the , physical scrolling is enabled. If a is the , scrolling is logical by child element. + If a control is the , physical scrolling is enabled. If a is the , scrolling is logical by child element. ]]> diff --git a/xml/System.Windows.Controls/StickyNoteControl.xml b/xml/System.Windows.Controls/StickyNoteControl.xml index c57bc3ff722..122124375b6 100644 --- a/xml/System.Windows.Controls/StickyNoteControl.xml +++ b/xml/System.Windows.Controls/StickyNoteControl.xml @@ -142,7 +142,7 @@ ## Remarks This property enables you to match the sticky note with the corresponding annotated object. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -257,7 +257,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -329,7 +329,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -401,7 +401,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -473,7 +473,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -545,7 +545,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -636,7 +636,7 @@ takes a parameter of type . The command's method will put the cursor in the mode specified by the parameter. + When used, the takes a parameter of type . The command's method will put the cursor in the mode specified by the parameter. ]]> @@ -709,7 +709,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -744,7 +744,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -825,7 +825,7 @@ ## Remarks -The identifier for the dependency property. +The identifier for the dependency property. ]]> @@ -905,7 +905,7 @@ The identifier for the dependency property. + The identifier for the dependency property. ]]> @@ -941,7 +941,7 @@ The identifier for the is performed automatically after the control applies an ink or text sticky note template to the control. + is performed automatically after the control applies an ink or text sticky note template to the control. ]]> @@ -1083,7 +1083,7 @@ The identifier for the | -|Metadata properties set to `true`|,

| +|Metadata properties set to `true`|,

| ]]> @@ -1192,7 +1192,7 @@ The identifier for the dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Controls/StyleSelector.xml b/xml/System.Windows.Controls/StyleSelector.xml index d11a04fc1f0..b70403f8f99 100644 --- a/xml/System.Windows.Controls/StyleSelector.xml +++ b/xml/System.Windows.Controls/StyleSelector.xml @@ -27,12 +27,12 @@ that applies a style based on custom logic, create a subclass of the class and implement the method. + To create a that applies a style based on custom logic, create a subclass of the class and implement the method. ## Examples - The following example shows how to define a that defines a for a row. This example defines the color according to the row index. + The following example shows how to define a that defines a for a row. This example defines the color according to the row index. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window11.xaml.cs" id="Snippetitemstyleselector"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/StyleSelector/Overview/window1.xaml.vb" id="Snippetitemstyleselector"::: @@ -45,7 +45,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window11.xaml" id="Snippetstyleselectorxaml"::: - For an example of how to create a selector to choose a defined style resource, see the implementation of , which allows you to use custom logic to select a , based on a similar concept. + For an example of how to create a selector to choose a defined style resource, see the implementation of , which allows you to use custom logic to select a , based on a similar concept. ]]> @@ -121,12 +121,12 @@ that applies a style based on custom logic, create a subclass of the class and implement the method. + To create a that applies a style based on custom logic, create a subclass of the class and implement the method. ## Examples - The following example shows how to define a that defines a for a row. This example defines the color according to the row index. + The following example shows how to define a that defines a for a row. This example defines the color according to the row index. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window11.xaml.cs" id="Snippetitemstyleselector"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/StyleSelector/Overview/window1.xaml.vb" id="Snippetitemstyleselector"::: @@ -139,7 +139,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/GridView/Overview/Window11.xaml" id="Snippetstyleselectorxaml"::: - For an example of how to create a selector to choose a defined style resource, see the implementation of , which allows you to use custom logic to select a , based on a similar concept. + For an example of how to create a selector to choose a defined style resource, see the implementation of , which allows you to use custom logic to select a , based on a similar concept. ]]> diff --git a/xml/System.Windows.Controls/TabControl.xml b/xml/System.Windows.Controls/TabControl.xml index 882edea7bac..829911a4a1e 100644 --- a/xml/System.Windows.Controls/TabControl.xml +++ b/xml/System.Windows.Controls/TabControl.xml @@ -120,16 +120,16 @@ can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or of a , the property is ignored. + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). If you set the or of a , the property is ignored. ## Examples - The following example binds a to a collection of `Student` objects. The `Student` class has a `Name` property, a collection of `Course` objects, and implements the method to return either the `Name` of the student or a string that lists the student's courses. The example uses to put a student's name in the of each (which inherits from ), and the to display the course list for each student in the Content of the . + The following example binds a to a collection of `Student` objects. The `Student` class has a `Name` property, a collection of `Course` objects, and implements the method to return either the `Name` of the student or a string that lists the student's courses. The example uses to put a student's name in the of each (which inherits from ), and the to display the course list for each student in the Content of the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml" id="Snippettabcontrol"::: - The following example implements the method to return either the `Name` of the student or a string that lists the student's courses. + The following example implements the method to return either the `Name` of the student or a string that lists the student's courses. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ContentControl/ContentStringFormat/Window1.xaml.cs" id="Snippettabcontroltostring"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/GroupStyle/HeaderStringFormat/window1.xaml.vb" id="Snippettabcontroltostring"::: @@ -229,7 +229,7 @@ ## Examples - The following example creates two objects. The called `contentTemplate` is assigned to the of the and the called `tabItemTemplate` is assigned to the of the second . All objects contain the white rectangle defined in `contentTemplate`, except the second , which has a gray rectangle, as defined in `tabItemTemplate`. + The following example creates two objects. The called `contentTemplate` is assigned to the of the and the called `tabItemTemplate` is assigned to the of the second . All objects contain the white rectangle defined in `contentTemplate`, except the second , which has a gray rectangle, as defined in `tabItemTemplate`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TabControl/ContentTemplate/page1.xaml" id="Snippet1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TabControl/ContentTemplate/page1.xaml" id="Snippet2"::: @@ -298,9 +298,9 @@ ## Remarks Typically, you create a when you have more than one for the same type of objects and you want to supply your own logic to choose a to apply based on the properties of each data object. Note that if you have objects of different types, you can set the property on the . If you do that, then there is no need to create a . Furthermore, if you have objects of the same type but with different properties, you can also consider using a or a data converter. For more information, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. + To create a template selector, create a class that inherits from and override the method. After your class is defined, you can assign an instance of the class to the template selector property of your element. - If both the and the properties are set, then this property is ignored. + If both the and the properties are set, then this property is ignored. ## XAML Attribute Usage @@ -326,10 +326,10 @@ One of the following: `StaticResource`, or `DynamicResource`. See [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). *DataTemplateSelectorClassKey* - The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. + The key that identifies the selector implementation being requested. The key refers to a derived class that implements a practical override. For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). You can also programmatically add an instance of your class as a resource to a resource dictionary. *MyDataTemplateSelectorImplementation* - A class derived from and overrides . For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + A class derived from and overrides . For information about how to map your custom class, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). ## Dependency Property Information @@ -476,7 +476,7 @@ , , and properties to the objects used by the currently selected . + This method updates the , , and properties to the objects used by the currently selected . ]]> @@ -545,7 +545,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -661,9 +661,9 @@ updates the , , and properties to the objects used by the currently selected . + The updates the , , and properties to the objects used by the currently selected . - The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -708,7 +708,7 @@ of the active when the tab selection changes. + This property is updated to reference the of the active when the tab selection changes. The of the uses the property to bind the property to this property. If you create a new for the , be sure to the bind the property to this property by setting the property to "SelectedContent" or by using [TemplateBinding Markup Extension](/dotnet/framework/wpf/advanced/templatebinding-markup-extension). @@ -733,7 +733,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/TabControl/ContentTemplateSelector/Window1.xaml.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/TabControl/ContentTemplateSelector/Window1.xaml.vb" id="Snippet4"::: - The following example creates a for the . Setting the property to "SelectedContent" creates aliases to the , , and properties. + The following example creates a for the . Setting the property to "SelectedContent" creates aliases to the , , and properties. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/tabcontrol.xaml" id="Snippet13"::: @@ -866,7 +866,7 @@ updates this property to reference to the for the active when the tab selection changes. Set or the property on a to specify the for a . + The updates this property to reference to the for the active when the tab selection changes. Set or the property on a to specify the for a . The of the uses the property to bind the property to this property. If you create a new for the , be sure to the bind the property to this property by setting the property to "SelectedContent" or by using [TemplateBinding Markup Extension](/dotnet/framework/wpf/advanced/templatebinding-markup-extension). @@ -888,7 +888,7 @@ ## Examples - The following example creates a for the . Setting the property to `"SelectedContent"` creates aliases to the , , and properties. + The following example creates a for the . Setting the property to `"SelectedContent"` creates aliases to the , , and properties. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/tabcontrol.xaml" id="Snippet13"::: @@ -964,7 +964,7 @@ updates this property to reference to the for the active when the tab selection changes. Set or the property on a to specify the for a . + The updates this property to reference to the for the active when the tab selection changes. Set or the property on a to specify the for a . The of the uses the property to bind the property to this property. If you create a new for the , be sure to the bind the property to this property by setting property to "SelectedContent" or by using the [TemplateBinding Markup Extension](/dotnet/framework/wpf/advanced/templatebinding-markup-extension). @@ -986,7 +986,7 @@ ## Examples - The following example creates a for the . Setting the property to `"SelectedContent"` creates aliases to the , , and properties. + The following example creates a for the . Setting the property to `"SelectedContent"` creates aliases to the , , and properties. :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/tabcontrol.xaml" id="Snippet13"::: diff --git a/xml/System.Windows.Controls/TabItem.xml b/xml/System.Windows.Controls/TabItem.xml index e663fefeb88..9bf701f4740 100644 --- a/xml/System.Windows.Controls/TabItem.xml +++ b/xml/System.Windows.Controls/TabItem.xml @@ -34,7 +34,7 @@ is a . Its content property is and its header property is . For more information, see the class. + is a . Its content property is and its header property is . For more information, see the class. ## Customizing the TabControl Control To apply the same property settings to multiple controls, use the property. You can modify the default to give the control a unique appearance. For more information about creating a , see [How to create a template for a control](/dotnet/desktop/wpf/controls/how-to-create-apply-template). To see the parts and states that are specific to the , see [TabControl Styles and Templates](/dotnet/framework/wpf/controls/tabcontrol-styles-and-templates). @@ -131,7 +131,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | @@ -519,7 +519,7 @@ ## Examples - The following example shows how to retrieve information about a . + The following example shows how to retrieve information about a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/TabItem/TabStripPlacement/Pane1.xaml.cs" id="Snippettabitemplacement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/TabItem/TabStripPlacement/pane1.xaml.vb" id="Snippettabitemplacement"::: diff --git a/xml/System.Windows.Controls/TextBlock.xml b/xml/System.Windows.Controls/TextBlock.xml index a076eb55e3e..237ef7d4c0c 100644 --- a/xml/System.Windows.Controls/TextBlock.xml +++ b/xml/System.Windows.Controls/TextBlock.xml @@ -55,7 +55,7 @@ is not optimized for scenarios that need to display more than a few lines of content; for such scenarios, a coupled with an appropriate viewing control is a better choice than , in terms of performance. After , is the next lightest-weight control for displaying flow content, and simply provides a scrolling content area with minimal UI. is optimized around "page-at-a-time" viewing mode for flow content. Finally, supports the richest set functionality for viewing flow content, but is correspondingly heavier-weight. - Horizontally aligning text within a is done with the property. Aligning the within the layout of the page is done with the and properties. + Horizontally aligning text within a is done with the property. Aligning the within the layout of the page is done with the and properties. @@ -193,7 +193,7 @@ . + This method overrides . ]]> @@ -229,7 +229,7 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. For a table of swatches that show the available predefined brush colors, see . @@ -239,12 +239,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -317,7 +317,7 @@ ## Remarks The baseline is the imaginary horizontal line with which the base of each character in a line of text is aligned. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a . In code, the attached property usage is supported by and . + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a . In code, the attached property usage is supported by and . ]]> @@ -539,13 +539,13 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. When multiple families are specified, the second and subsequent font families serve as fallback families to be used in cases where the primary font family is unavailable or not applicable. - This property specifies a preference only. If the specified font family is not available, the silently falls back to the font determined by the value. + This property specifies a preference only. If the specified font family is not available, the silently falls back to the font determined by the value. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontFamily` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontFamily` property, which the uses for rendering. ## XAML Attribute Usage @@ -580,12 +580,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -666,9 +666,9 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontSize` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontSize` property, which the uses for rendering. ## XAML Attribute Usage @@ -703,12 +703,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -779,9 +779,9 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names of the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStretch` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names of the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStretch` property, which the uses for rendering. ## Dependency Property Information @@ -789,12 +789,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -865,9 +865,9 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names in the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStyle` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names in the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStyle` property, which the uses for rendering. ## Dependency Property Information @@ -875,12 +875,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -951,11 +951,11 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. For a list of valid values of font weights, see the class. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values of a property of the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontWeight` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values of a property of the class. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontWeight` property, which the uses for rendering. ## Dependency Property Information @@ -963,12 +963,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -1041,9 +1041,9 @@ ## Remarks For a table of swatches that show the available pre-defined brush colors, see . - Any settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string that resolves to a implementation value. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `Foreground` property, which the uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string that resolves to a implementation value. In code, the attached property usage is supported by and . The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `Foreground` property, which the uses for rendering. ## Dependency Property Information @@ -1051,12 +1051,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -1589,7 +1589,7 @@ . + This method overrides . ]]> @@ -1633,7 +1633,7 @@ ## Remarks This method is intended to enable precise hit testing for rendered content. - This method overrides . + This method overrides . ]]> @@ -1784,7 +1784,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -1859,7 +1859,7 @@ In addition to this property, the layout of lines in a is affected by its property. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string as explained in XAML Values. In code, the attached property usage is supported by and . The attached property usage is not common. ## XAML Attribute Usage @@ -1899,12 +1899,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -1978,7 +1978,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is a string value of the enumeration. In code, the attached property usage is supported by and . The attached property usage is not common. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string value of the enumeration. In code, the attached property usage is supported by and . The attached property usage is not common. ## Dependency Property Information @@ -1986,12 +1986,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -2096,7 +2096,7 @@ ## Remarks Override this method to implement custom sizing behavior. - This method overrides . + This method overrides . ]]> @@ -2165,7 +2165,7 @@ . + This method overrides . ]]> @@ -2204,7 +2204,7 @@ . + This method overrides . ]]> @@ -2282,7 +2282,7 @@ can be described as uniform in all directions (`Padding="10"`), or as four distinct values that represent left, top, right, and bottom padding independently (`Padding="5,0,10,20"`). + can be described as uniform in all directions (`Padding="10"`), or as four distinct values that represent left, top, right, and bottom padding independently (`Padding="5,0,10,20"`). If a specified padding thickness exceeds the corresponding content area dimension (for example, the sum of the left and right padding widths exceeds the content area width), the thickness of the padding is proportionally reduced to be no greater than the relevant content area dimension. @@ -2331,12 +2331,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -3178,12 +3178,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/Text/Window1.xaml" id="Snippet_textblock_text1xaml"::: @@ -3228,7 +3228,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is a string value of the enumeration. In code, the attached property usage is supported by and . The attached property usage is not common. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string value of the enumeration. In code, the attached property usage is supported by and . The attached property usage is not common. ## Dependency Property Information @@ -3236,12 +3236,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -3323,12 +3323,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute. + The following example shows how to set the attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextDecorations/Window1.xaml" id="Snippet_textblock_textdecxaml"::: @@ -3336,7 +3336,7 @@ ![Screenshot: Text with default strikethrough effect](~/add/media/inline-textdec-strike.png "Screenshot: Text with default strikethrough effect") - The following figures show how the , , and decorations render, respectively. + The following figures show how the , , and decorations render, respectively. ![Screenshot: Overline TextDecorator](~/add/media/inline-textdec-over.png "Screenshot: Overline TextDecorator") @@ -3419,7 +3419,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -3526,7 +3526,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -3597,12 +3597,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: @@ -3678,7 +3678,7 @@ ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_textblockpropsxaml"::: diff --git a/xml/System.Windows.Controls/TextBox.xml b/xml/System.Windows.Controls/TextBox.xml index c4bef16f9a3..95a5b0628f9 100644 --- a/xml/System.Windows.Controls/TextBox.xml +++ b/xml/System.Windows.Controls/TextBox.xml @@ -51,14 +51,14 @@ Example of a TextBox supports unformatted text only. For applications that require support for richer content, see . For applications that need to accept passwords or other sensitive input, see . - Horizontally and vertically aligning text within a is done with the and properties. Aligning the within the layout of the page is done with the and properties. + Horizontally and vertically aligning text within a is done with the and properties. Aligning the within the layout of the page is done with the and properties. The best way to hide the border around a is to set the property of the to `0`. > [!IMPORTANT] -> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for or events from a will not be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. +> has built-in handling for the bubbling and events. Consequently, custom event handlers that listen for or events from a will not be called. If you need to respond to these events, listen for the tunneling and events instead, or register the handlers with the argument (this latter option is only available through code). Do not mark the event handled unless you deliberately want to disable native handling of these events, and be aware that this has notable effects on the control's UI. - Scrollbars are not visible on a by default. To make scrollbars visible, set the and properties to or . + Scrollbars are not visible on a by default. To make scrollbars visible, set the and properties to or . Usually the event should be used to detect whenever the text in a or changes rather then as you might expect. See [How to: Detect When Text in a TextBox Has Changed](/dotnet/framework/wpf/controls/how-to-detect-when-text-in-a-textbox-has-changed) for an example. @@ -933,7 +933,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." ## Examples - The following example shows how to create a with a of 500 characters. + The following example shows how to create a with a of 500 characters. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/textboxexample.xaml" id="Snippettextboxexamplewholepage"::: @@ -1009,11 +1009,11 @@ tbSettingText.Text = "Initial text contents of the TextBox." . Setting this property causes the text box to resize if the number of visible lines exceeds the limit specified by . + Getting this property returns the current value of . Setting this property causes the text box to resize if the number of visible lines exceeds the limit specified by . This property applies only to visible lines, and does not constrain the actual number of lines. Depending on its configuration, a text box may contain additional non-visible lines that are accessible by scrolling. - If the property is explicitly set on a , the and property values are ignored. + If the property is explicitly set on a , the and property values are ignored. ## Dependency Property Information @@ -1021,12 +1021,12 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to create a with a value of 5. + The following example shows how to create a with a value of 5. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/textboxexample.xaml" id="Snippettextboxexamplewholepage"::: @@ -1145,9 +1145,9 @@ tbSettingText.Text = "Initial text contents of the TextBox." . Setting this property causes the text box to resize if the number of visible lines is less than value specified by . + Getting this property returns the current value of . Setting this property causes the text box to resize if the number of visible lines is less than value specified by . - If the property is explicitly set on a , the and property values are ignored. + If the property is explicitly set on a , the and property values are ignored. ## Dependency Property Information @@ -1155,12 +1155,12 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to create a with a value of 1. + The following example shows how to create a with a value of 1. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/textboxexample.xaml" id="Snippettextboxexamplewholepage"::: @@ -1234,7 +1234,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." . + This method overrides . ]]> @@ -1273,7 +1273,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." . + This method overrides . ]]> @@ -1700,7 +1700,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -1748,12 +1748,12 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to create a with a of . + The following example shows how to create a with a of . :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/CharacterCasing/Overview/textboxexample.xaml" id="Snippettextboxexamplewholepage"::: @@ -1832,12 +1832,12 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextDecorations/Window1.xaml" id="Snippet_inline_textdecxaml"::: @@ -1845,7 +1845,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." ![Screenshot: Text with default strikethrough effect](~/add/media/inline-textdec-strike.png "Screenshot: Text with default strikethrough effect") - The following figures show how the , , and decorations render, respectively. + The following figures show how the , , and decorations render, respectively. ![Screenshot: Overline TextDecorator](~/add/media/inline-textdec-over.png "Screenshot: Overline TextDecorator") @@ -1891,7 +1891,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." dependency property. + The identifier for the dependency property. ]]> @@ -1955,7 +1955,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." attribute to causes entered text to wrap to a new line when the edge of the control is reached, automatically expanding the height of the control to include room for a new line, if necessary. + Setting the attribute to causes entered text to wrap to a new line when the edge of the control is reached, automatically expanding the height of the control to include room for a new line, if necessary. ## Dependency Property Information @@ -1963,7 +1963,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -2006,7 +2006,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." dependency property. + The identifier for the dependency property. ]]> @@ -2047,7 +2047,7 @@ tbSettingText.Text = "Initial text contents of the TextBox." ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_typogxaml"::: diff --git a/xml/System.Windows.Controls/TextChangedEventArgs.xml b/xml/System.Windows.Controls/TextChangedEventArgs.xml index 64908ae82ed..34eb17440f7 100644 --- a/xml/System.Windows.Controls/TextChangedEventArgs.xml +++ b/xml/System.Windows.Controls/TextChangedEventArgs.xml @@ -114,7 +114,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -158,7 +158,7 @@ ## Remarks There is one object for each consecutive change to the control. More than one consecutive change can occur during one occurrence of the event when the change entails changing the structure of the underlying document. - For example, suppose that a contains the string `"This is some text."` The structure of the is `This is some text.`. If the user bolds the words `"is some"`, the structure of the underlying changes to `This is some text.`. There are actually four changes that took place as a result of the user's action: + For example, suppose that a contains the string `"This is some text."` The structure of the is `This is some text.`. If the user bolds the words `"is some"`, the structure of the underlying changes to `This is some text.`. There are actually four changes that took place as a result of the user's action: 1. The `` symbol is removed and re-added before the word `This`. @@ -174,13 +174,13 @@ - The collection is ordered consecutively, related to where the change occurred in the control. For example, a object that represents a change at position 2 is before a object that represents a change at position 10. -- Two objects do not represent an overlapping area. The value of plus the value of of one object is always less than or equal to the value of of the next object in the collection. Likewise, the value of plus the value of of one object is always less than or equal to the value of of the next object in the collection. +- Two objects do not represent an overlapping area. The value of plus the value of of one object is always less than or equal to the value of of the next object in the collection. Likewise, the value of plus the value of of one object is always less than or equal to the value of of the next object in the collection. - The collection reflects whatever changes occurred, even if there seems to be no net change. In the preceding example, neither the first or fourth change results in a net change, because each simply removed and re-added the `` and `` symbols, respectively. But the symbols were actually removed and added, so they are included in the collection. - If the event occurs as a result of a property change, is an empty collection. In the preceding example, if the user bolds the entire string, the property of the is set to , but nothing is added or removed from the document, so is empty. + If the event occurs as a result of a property change, is an empty collection. In the preceding example, if the user bolds the entire string, the property of the is set to , but nothing is added or removed from the document, so is empty. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Controls/TextSearch.xml b/xml/System.Windows.Controls/TextSearch.xml index 7ced7032e2a..22801e2251d 100644 --- a/xml/System.Windows.Controls/TextSearch.xml +++ b/xml/System.Windows.Controls/TextSearch.xml @@ -29,9 +29,9 @@ ## Remarks This class is used to assign a string to items in a control's collection. Assigning a string to each item in the collection accomplishes two objectives. It specifies the text to display when the item is selected, and it enables the user to select an item by typing the assigned string. - For example, assume that a contains a collection of objects, one of which is an image of a dog. If you assign the string, "Dog" to that item, the user can select the dog by typing the word in the combo box's text box. As soon as the user types enough of the word to distinguish it from other items in the selection, the image of the dog will be selected. If is set to `true` on the , "Dog" will appear in the text box. + For example, assume that a contains a collection of objects, one of which is an image of a dog. If you assign the string, "Dog" to that item, the user can select the dog by typing the word in the combo box's text box. As soon as the user types enough of the word to distinguish it from other items in the selection, the image of the dog will be selected. If is set to `true` on the , "Dog" will appear in the text box. - You can specify the text that identifies an item by using the property on a control or by setting the property on each item in the control's collection. Setting one of these properties ensures that unexpected text is not displayed. If you set the property on a control's collection item, the property will be ignored. If you set the property to a value that is not the name of an actual property, is ignored. + You can specify the text that identifies an item by using the property on a control or by setting the property on each item in the control's collection. Setting one of these properties ensures that unexpected text is not displayed. If you set the property on a control's collection item, the property will be ignored. If you set the property to a value that is not the name of an actual property, is ignored. ## XAML Text Usage @@ -91,7 +91,7 @@ attached property from the specified element. + This method returns the value of the attached property from the specified element. ]]> @@ -137,7 +137,7 @@ attached property from the specified element. + This method returns the value of the attached property from the specified element. ]]> @@ -244,7 +244,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -283,7 +283,7 @@ . If you set the property on a control's collection item, the property will be ignored. If you set the property to a value that is not the name of an actual property, is ignored. + Use this property on a control that contains a collection of items. The value of the specified property is the text that the user can type to select the item, and the text that is displayed if the control is set to display text in its . If you set the property on a control's collection item, the property will be ignored. If you set the property to a value that is not the name of an actual property, is ignored. ## Dependency Property Information diff --git a/xml/System.Windows.Controls/ToolBar.xml b/xml/System.Windows.Controls/ToolBar.xml index 4c4b0a1ada5..892c984ecf4 100644 --- a/xml/System.Windows.Controls/ToolBar.xml +++ b/xml/System.Windows.Controls/ToolBar.xml @@ -123,12 +123,12 @@ in a depends on the values of the , , and properties. When is set to , a band represents a row in the . When is , a band represents a column of the . The following table describes the relationship between , , and . + The position of the in a depends on the values of the , , and properties. When is set to , a band represents a row in the . When is , a band represents a column of the . The following table describes the relationship between , , and . |Orientation|Band|BandIndex| |-----------------|----------|---------------| -|Horizontal|Indicates the row in which the is positioned. Toolbars that have set to a smaller value are above those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are to the left of those with a larger value.| -|Vertical|Indicates the column in which the is positioned. Toolbars that have set to a smaller value are to the left of those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are above those with a larger value.| +|Horizontal|Indicates the row in which the is positioned. Toolbars that have set to a smaller value are above those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are to the left of those with a larger value.| +|Vertical|Indicates the column in which the is positioned. Toolbars that have set to a smaller value are to the left of those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are above those with a larger value.| ## Dependency Property Information @@ -136,7 +136,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -182,14 +182,14 @@ is set in the . For example, if you put two toolbars in a without setting the and properties, the value of will be 0 for both toolbars. The value of will be 0 for the first toolbar and 1 for the second toolbar. + If you do not explicitly set this property, its value is determined by the order in which the is set in the . For example, if you put two toolbars in a without setting the and properties, the value of will be 0 for both toolbars. The value of will be 0 for the first toolbar and 1 for the second toolbar. - The position of the in a depends on the values of the , , and properties. When is set to , a band represents a row in the . When is , a band represents a column of the . The following table describes the relationship between , , and . + The position of the in a depends on the values of the , , and properties. When is set to , a band represents a row in the . When is , a band represents a column of the . The following table describes the relationship between , , and . |Orientation|Band|BandIndex| |-----------------|----------|---------------| -|Horizontal|Indicates the row in which the is positioned. Toolbars that have set to a smaller value are above those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are to the left of those with a larger value.| -|Vertical|Indicates the column in which the is positioned. Toolbars that have set to a smaller value are to the left of those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are above those with a larger value.| +|Horizontal|Indicates the row in which the is positioned. Toolbars that have set to a smaller value are above those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are to the left of those with a larger value.| +|Vertical|Indicates the column in which the is positioned. Toolbars that have set to a smaller value are to the left of those with a larger value.|Indicates the position of the on the . Toolbars that have set to a smaller value are above those with a larger value.| ## Dependency Property Information @@ -197,7 +197,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -692,7 +692,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Controls/ToolBarTray.xml b/xml/System.Windows.Controls/ToolBarTray.xml index 2fa456083d7..21d0b84964f 100644 --- a/xml/System.Windows.Controls/ToolBarTray.xml +++ b/xml/System.Windows.Controls/ToolBarTray.xml @@ -149,7 +149,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -308,7 +308,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -483,7 +483,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -667,7 +667,7 @@ objects to a by using XAML, but do not use object element syntax. That is, do not explicitly specify the object. XAML does not support declaring generic types. + You can add objects to a by using XAML, but do not use object element syntax. That is, do not explicitly specify the object. XAML does not support declaring generic types. ## XAML Property Element Usage diff --git a/xml/System.Windows.Controls/ToolTip.xml b/xml/System.Windows.Controls/ToolTip.xml index e31d30219ac..cba905511bc 100644 --- a/xml/System.Windows.Controls/ToolTip.xml +++ b/xml/System.Windows.Controls/ToolTip.xml @@ -42,7 +42,7 @@ You use a control to provide information to the user. For example, you can use a to provide the name of a or a in a . The content of a control can vary from a simple text string to more complex content such as a that has embedded text and images. The content of a cannot receive focus. - A control cannot have a parent. For example, you cannot set the property of a to a Instead, assign a to the and properties. + A control cannot have a parent. For example, you cannot set the property of a to a Instead, assign a to the and properties. You can use a on multiple elements by defining a in a . @@ -237,7 +237,7 @@ ## Remarks The property must be set to for the callback delegate to be used. - The delegate returns an array of possible points that are defined with respect to the . When the is displayed, a point is chosen that maximizes the amount of the window that is visible. + The delegate returns an array of possible points that are defined with respect to the . When the is displayed, a point is chosen that maximizes the amount of the window that is visible. ## Dependency Property Information @@ -320,7 +320,7 @@ opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. + When the opens, the value is set to the value of . Setting this property to `true` has no effect if the property is `false`. ## Dependency Property Information @@ -414,7 +414,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -848,7 +848,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -944,7 +944,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1045,7 +1045,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1205,7 +1205,7 @@ property is not supported for a when it is not open. To create a tooltip that stays open until the mouse button is pressed when it is outside the tooltip, you must set both the property and the property to `true`. If is set to `false` when the tooltip is not open, a occurs. + A value of `false` for the property is not supported for a when it is not open. To create a tooltip that stays open until the mouse button is pressed when it is outside the tooltip, you must set both the property and the property to `true`. If is set to `false` when the tooltip is not open, a occurs. ## Dependency Property Information @@ -1292,7 +1292,7 @@ by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + You can position a by setting the , , , , and properties. These properties behave the same as they do for a . For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information diff --git a/xml/System.Windows.Controls/ToolTipEventArgs.xml b/xml/System.Windows.Controls/ToolTipEventArgs.xml index e726ccc470f..426465dc51c 100644 --- a/xml/System.Windows.Controls/ToolTipEventArgs.xml +++ b/xml/System.Windows.Controls/ToolTipEventArgs.xml @@ -24,22 +24,22 @@ Provides event information for events that occur when a tooltip opens or closes. - or . Therefore, open and close events exist on both of these classes. The following table lists the events that use this class. - -|Events that occur when a tooltip opens|Events that occur when a tooltip closes| -|--------------------------------------------|---------------------------------------------| -||| -||| - - These events are registered by the class as the and fields. The and classes both implement the and expose this event by defining the events in the previous table - - The class overrides the method. However, this protected member does not appear on the list of members because the method is sealed and cannot be overridden in classes from . The implementation of the method in this class casts the event handler delegate that is provided as a parameter to the method to the type. - - If the tooltip is defined as a object, the and events of the class are also raised when a tooltip opens and closes. - + or . Therefore, open and close events exist on both of these classes. The following table lists the events that use this class. + +|Events that occur when a tooltip opens|Events that occur when a tooltip closes| +|--------------------------------------------|---------------------------------------------| +||| +||| + + These events are registered by the class as the and fields. The and classes both implement the and expose this event by defining the events in the previous table + + The class overrides the method. However, this protected member does not appear on the list of members because the method is sealed and cannot be overridden in classes from . The implementation of the method in this class casts the event handler delegate that is provided as a parameter to the method to the type. + + If the tooltip is defined as a object, the and events of the class are also raised when a tooltip opens and closes. + ]]> diff --git a/xml/System.Windows.Controls/ToolTipService.xml b/xml/System.Windows.Controls/ToolTipService.xml index 0dc1481ea88..3b3e22a71b3 100644 --- a/xml/System.Windows.Controls/ToolTipService.xml +++ b/xml/System.Windows.Controls/ToolTipService.xml @@ -28,7 +28,7 @@ or property. The ToolTip property takes one child. The content of the child can vary from a simple text string to more complex content such as a that has embedded text and elements. + You define a tooltip for an element by setting the or property. The ToolTip property takes one child. The content of the child can vary from a simple text string to more complex content such as a that has embedded text and elements. You can define tooltip content as a object, but this is not required. When you do not define the tooltip content as a object, you can use the properties to position and customize the tooltip content. Attached properties of the class are used to determine the placement, behavior, and appearance of a tooltip. These properties are set on the element that defines the tooltip. @@ -36,15 +36,15 @@ The following timing properties are only defined for the class and are used by all tooltips: -- +- -- +- -- +- For information about how to handle the events that occur when the tooltip opens or closes, see the and fields. - , , , , and behave similarly to the properties of the same name in the class. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + , , , , and behave similarly to the properties of the same name in the class. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). @@ -151,9 +151,9 @@ property. However, after a tooltip is displayed there is a period of time during which another tooltip can be displayed without waiting for the time to pass. You specify this time period by using the property. When the user moves the mouse within this time period from one element that has a visible tooltip to another element that has a tooltip, the value of the property for the second tooltip is not applied and the second tooltip appears immediately. + Typically, when a user moves the mouse pointer over an object that has a tooltip, there is a delay before the tooltip is displayed. This delay is equal to the value of the property. However, after a tooltip is displayed there is a period of time during which another tooltip can be displayed without waiting for the time to pass. You specify this time period by using the property. When the user moves the mouse within this time period from one element that has a visible tooltip to another element that has a tooltip, the value of the property for the second tooltip is not applied and the second tooltip appears immediately. - For information about how to get or set this property, see the and methods. + For information about how to get or set this property, see the and methods. ## Dependency Property Information @@ -239,7 +239,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.BetweenShowDelay` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetbetweenshowdelay"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetbetweenshowdelay"::: @@ -290,7 +290,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.HasDropShadow` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgethasdropshadow"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgethasdropshadow"::: @@ -345,7 +345,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.HorizontalOffset` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgethorizontaloffset"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgethorizontaloffset"::: @@ -396,7 +396,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.InitialShowDelay` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetinitialshowdelay"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetinitialshowdelay"::: @@ -447,7 +447,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.IsEnabled` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetisenabled"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetisenabled"::: @@ -498,7 +498,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.IsOpen` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetisopen"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetisopen"::: @@ -548,7 +548,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.Placement` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetplacement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetplacement"::: @@ -599,7 +599,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.PlacementRectangle` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetplacementrectangle"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetplacementrectangle"::: @@ -650,7 +650,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.PlacementTarget` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetplacementtarget"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetplacementtarget"::: @@ -701,7 +701,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.ShowDuration` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetshowduration"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetshowduration"::: @@ -752,7 +752,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.ShowOnDisabledProperty` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetshowondisabled"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetshowondisabled"::: @@ -834,7 +834,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.ToolTipProperty` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgettooltip"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgettooltip"::: @@ -889,7 +889,7 @@ method finds the object called `ellipse2`, which is an . + The following example shows how to get the value for the `ToolTipService.VerticalOffset` attached property. The method finds the object called `ellipse2`, which is an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml.cs" id="Snippetgetverticaloffset"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/ToolTip/Closed/pane1.xaml.vb" id="Snippetgetverticaloffset"::: @@ -929,7 +929,7 @@ If the tooltip is a object and both the property and the property are specified, the value of the property is used. - For information about how to get or set this property in code, see the and methods. + For information about how to get or set this property in code, see the and methods. ## Dependency Property Information @@ -942,7 +942,7 @@ ## Examples - The following example shows how to set the attached property of the class. + The following example shows how to set the attached property of the class. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/ToolTip/Closed/Pane1.xaml" id="Snippetnotooltip"::: @@ -1008,7 +1008,7 @@ ## Remarks The property and the property values provide additional adjustment to the position of a tooltip that is defined by the property and the property values. - behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## XAML Attribute Usage @@ -1037,7 +1037,7 @@ `pt` is points; 1pt==(96/72) px - For information about how to get or set this property in code, see the and methods. + For information about how to get or set this property in code, see the and methods. ## Dependency Property Information @@ -1107,9 +1107,9 @@ property. However, after a tooltip is displayed there is a period of time during which another tooltip can be displayed without waiting for the time to pass. You specify this time period by using the property. When the user moves the mouse within this time period from one element that has a visible tooltip to another element that has a tooltip, the value of the property for the second tooltip is not applied and the second tooltip appears immediately. + Typically, when a user moves the mouse pointer over an object that has a tooltip, there is a delay before the tooltip is displayed. This delay is equal to the value of the property. However, after a tooltip is displayed there is a period of time during which another tooltip can be displayed without waiting for the time to pass. You specify this time period by using the property. When the user moves the mouse within this time period from one element that has a visible tooltip to another element that has a tooltip, the value of the property for the second tooltip is not applied and the second tooltip appears immediately. - For information about how to get or set this property in code, see the and methods. + For information about how to get or set this property in code, see the and methods. ## Dependency Property Information @@ -1190,7 +1190,7 @@ ## Remarks To determine whether a tooltip is currently visible, use the property. - For information about how to get or set this property in code, see the and methods. + For information about how to get or set this property in code, see the and methods. ## Dependency Property Information @@ -1275,7 +1275,7 @@ ## Remarks To determine whether a tooltip can appear, check the value of the property. -This is an attached property. For information about how to get the value of this property in code, see the method. +This is an attached property. For information about how to get the value of this property in code, see the method. ]]> @@ -1336,9 +1336,9 @@ This is an attached property. For information about how to get the value of this and methods. + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. - behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1407,13 +1407,13 @@ This is an attached property. For information about how to get the value of this property specifies a structure relative to which the control is positioned when it opens. If is not `null`, the structure is defined relative to the object. Otherwise, the specified structure is defined relative to the upper-left corner of the screen. + The property specifies a structure relative to which the control is positioned when it opens. If is not `null`, the structure is defined relative to the object. Otherwise, the specified structure is defined relative to the upper-left corner of the screen. If the property is set to , the tooltip is displayed relative to the location of the mouse, and the value of the property has no effect. - This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. - behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -1482,13 +1482,13 @@ This is an attached property. For information about how to get the value of this does not have to be the object on which the tooltip is defined. For example, a that describes an could specify its tooltip to appear over the when the user pauses the mouse pointer on the . + The does not have to be the object on which the tooltip is defined. For example, a that describes an could specify its tooltip to appear over the when the user pauses the mouse pointer on the . - If you do not specify a and the tooltip has a visual parent, the visual parent acts as the . If the tooltip does not have a visual parent and the value of the property is `null`, the tooltip control is positioned relative to the upper-left corner of the screen. + If you do not specify a and the tooltip has a visual parent, the visual parent acts as the . If the tooltip does not have a visual parent and the value of the property is `null`, the tooltip control is positioned relative to the upper-left corner of the screen. - This property is an attached property. For information about how to get or set this property in code, see the and methods. + This property is an attached property. For information about how to get or set this property in code, see the and methods. - behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## Dependency Property Information @@ -2214,7 +2214,7 @@ This is an attached property. For information about how to get the value of this ## Remarks This property defines the time that a tooltip remains visible while the user pauses the mouse pointer over the object that defines the tooltip. If the user moves the mouse pointer off of the object, the tooltip closes. - This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. ## Dependency Property Information @@ -2296,7 +2296,7 @@ This is an attached property. For information about how to get the value of this and methods. + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. ## Dependency Property Information @@ -2422,9 +2422,9 @@ This is an attached property. For information about how to get the value of this ## Remarks Tooltip content can range from a simple text string to more complex objects such as a element that has embedded controls and images. However, tooltip content cannot take focus. For example, a inside a tooltip cannot receive a event. - Windows Presentation Foundation (WPF) provides a control that defines a tooltip and provides properties that you can use to specify tooltip behavior. However, a tooltip can be any element, such as a or an . + Windows Presentation Foundation (WPF) provides a control that defines a tooltip and provides properties that you can use to specify tooltip behavior. However, a tooltip can be any element, such as a or an . - This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. The XAML syntax shown here is appropriate if the object that fills the tooltip is a primitive with native type conversion, such as a string. If the object does not support native type conversion or support its own type converter, you might need to specify a verbose form of attached property syntax as follows: @@ -2673,7 +2673,7 @@ This is an attached property. For information about how to get the value of this and methods. behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). + This property is an attached property. For information about how to get or set the value of this property in code, see the and methods. behaves similarly to the property. For more information, see [Popup Placement Behavior](/dotnet/framework/wpf/controls/popup-placement-behavior). ## XAML Attribute Usage diff --git a/xml/System.Windows.Controls/TreeView.xml b/xml/System.Windows.Controls/TreeView.xml index be5edac35fb..aafcc6bdfc5 100644 --- a/xml/System.Windows.Controls/TreeView.xml +++ b/xml/System.Windows.Controls/TreeView.xml @@ -42,7 +42,7 @@ The contents of a are controls that can contain rich content, such as and controls. A can contain one or more objects as its descendants. A is defined as a hierarchy of objects. - A can populate its tree by binding to a data source and using objects. Examples of data sources include and objects. + A can populate its tree by binding to a data source and using objects. Examples of data sources include and objects. Displaying a large number of items may cause performance issues. See [Optimizing Performance: Controls](/dotnet/framework/wpf/advanced/optimizing-performance-controls) for more information. To improve the performance of a , see [How to: Improve the Performance of a TreeView](/dotnet/framework/wpf/controls/how-to-improve-the-performance-of-a-treeview). @@ -379,7 +379,7 @@ to `true` if one of the following keys is pressed together with the CTRL key: + This implementation sets to `true` if one of the following keys is pressed together with the CTRL key: - @@ -434,7 +434,7 @@ and a . The is set to the item that was previously selected, or is set to `null` if there is no previously selected item. Similarly, the is set to the newly selected item, or is set to `null` if no new item is selected. + The event data that the parameter `e` provides contains an and a . The is set to the item that was previously selected, or is set to `null` if there is no previously selected item. Similarly, the is set to the newly selected item, or is set to `null` if no new item is selected. ]]> @@ -582,7 +582,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier Field|| |Routing Strategy|Bubbling| -|Delegate|| +|Delegate|| ## XAML Attribute Usage @@ -709,7 +709,7 @@ property specifies the path to the property that is used to determine the value of the property. For example, assume that a is bound to a collection of objects of type `Employee`, which has two properties called `EmployeeName` and `EmployeeNumber`. You can use a to display the value of `EmployeeName` in the and set to `"EmployeeNumber"` to have return the value of `EmployeeNumber`. + The property specifies the path to the property that is used to determine the value of the property. For example, assume that a is bound to a collection of objects of type `Employee`, which has two properties called `EmployeeName` and `EmployeeNumber`. You can use a to display the value of `EmployeeName` in the and set to `"EmployeeNumber"` to have return the value of `EmployeeNumber`. The property is a read-only property. To change the value of a selected item in a , use the property to access the . @@ -724,7 +724,7 @@ ## Examples - The following example shows a that uses a to display the `EmployeeName` and `EmployeeWorkDay` properties of an `Employee` and sets the property to the `EmployeeNumber`. When you select an `EmployeeName` in the , the is set to the `EmployeeNumber`. + The following example shows a that uses a to display the `EmployeeName` and `EmployeeWorkDay` properties of an `Employee` and sets the property to the `EmployeeNumber`. When you select an `EmployeeName` in the , the is set to the `EmployeeNumber`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TreeView/SelectedValue/Window1.xaml" id="Snippetselectedvaluepath"::: @@ -774,7 +774,7 @@ property specifies the path to the property that is used to determine the value of the property. For example, assume that a is bound to a collection of objects of type `Employee`, which has two properties called `EmployeeName` and `EmployeeNumber`. You can use a to display the value of `EmployeeName` in the and set to `"EmployeeNumber"` to have return the value of `EmployeeNumber`. + The property specifies the path to the property that is used to determine the value of the property. For example, assume that a is bound to a collection of objects of type `Employee`, which has two properties called `EmployeeName` and `EmployeeNumber`. You can use a to display the value of `EmployeeName` in the and set to `"EmployeeNumber"` to have return the value of `EmployeeNumber`. ## Dependency Property Information @@ -787,7 +787,7 @@ ## Examples - The following example shows a that uses a to display the `EmployeeName` and `EmployeeWorkDay` properties of an `Employee` and sets the property to the `EmployeeNumber`. When you select an `EmployeeName` in the , the is set to the `EmployeeNumber`. + The following example shows a that uses a to display the `EmployeeName` and `EmployeeWorkDay` properties of an `Employee` and sets the property to the `EmployeeNumber`. When you select an `EmployeeName` in the , the is set to the `EmployeeNumber`. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TreeView/SelectedValue/Window1.xaml" id="Snippetselectedvaluepath"::: diff --git a/xml/System.Windows.Controls/TreeViewItem.xml b/xml/System.Windows.Controls/TreeViewItem.xml index f36b0dcb9eb..4cf068b9e0e 100644 --- a/xml/System.Windows.Controls/TreeViewItem.xml +++ b/xml/System.Windows.Controls/TreeViewItem.xml @@ -376,7 +376,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TreeViewItem/ExpandSubtree/mainwindow.xaml" id="Snippet1"::: - The following code traverses the to find the selected and then calls to display all child items of the selected . + The following code traverses the to find the selected and then calls to display all child items of the selected . > [!NOTE] > The `GetTreeViewItem` method only works for controls that are not virtualized. To learn how to find a that may be virtualized, see [How to: Find a TreeViewItem in a TreeView](/dotnet/framework/wpf/controls/how-to-find-a-treeviewitem-in-a-treeview). @@ -504,7 +504,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -583,7 +583,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -628,7 +628,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -687,7 +687,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -730,7 +730,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -930,7 +930,7 @@ selection when there is a change in the collection. + This implementation adjusts the selection when there is a change in the collection. ]]> @@ -969,7 +969,7 @@ to `true` and collapses or expands the when one of the following keys is pressed: + This method sets to `true` and collapses or expands the when one of the following keys is pressed: - @@ -1020,7 +1020,7 @@ is two, the value of the property switches to `true` or `false`, which causes the to expand or collapse. + If the mouse is two, the value of the property switches to `true` or `false`, which causes the to expand or collapse. This implementation marks the event as handled by setting the property of the event data to `true`. @@ -1064,7 +1064,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1107,7 +1107,7 @@ event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + The control raises the event by calling . For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -1149,7 +1149,7 @@ if is `true`. + This implementation updates the if is `true`. ]]> diff --git a/xml/System.Windows.Controls/UIElementCollection.xml b/xml/System.Windows.Controls/UIElementCollection.xml index 596d5cfc78d..950f7a58510 100644 --- a/xml/System.Windows.Controls/UIElementCollection.xml +++ b/xml/System.Windows.Controls/UIElementCollection.xml @@ -45,7 +45,7 @@ ## Examples - The following example uses the method to add child content to a parent . You do this by using the property, which is of type . + The following example uses the method to add child content to a parent . You do this by using the property, which is of type . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet1"::: @@ -120,7 +120,7 @@ method to add child content to a parent . You do this by using the property, which is of type . + The following example uses the method to add child content to a parent . You do this by using the property, which is of type . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet1"::: @@ -191,7 +191,7 @@ method to clear child content from a parent . You do this by using the property, which is of type . + The following example uses the method to clear child content from a parent . You do this by using the property, which is of type . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet1"::: @@ -267,7 +267,7 @@ method to determine if a specific exists within a . + The following example uses the method to determine if a specific exists within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/UIElementCollection/Contains/Pane1.xaml.vb" id="Snippet10"::: @@ -513,7 +513,7 @@ method to insert child content at a specified index position. + The following example uses the method to insert child content at a specified index position. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet5"::: @@ -665,7 +665,7 @@ method to remove child content at a specified index position. + The following example uses the method to remove child content at a specified index position. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/UIElementCollection/Overview/Pane1.xaml.cs" id="Snippet7"::: diff --git a/xml/System.Windows.Controls/Validation.xml b/xml/System.Windows.Controls/Validation.xml index 852c138d41c..83d9032c4e3 100644 --- a/xml/System.Windows.Controls/Validation.xml +++ b/xml/System.Windows.Controls/Validation.xml @@ -102,7 +102,7 @@ call or a previously failed validation. The object is valid after this call. + The `bindingExpression` object may have been invalid from a call or a previously failed validation. The object is valid after this call. ]]> @@ -134,19 +134,19 @@ with your object. Validation occurs during binding target-to-binding source value transfer before the converter is called. The following describes the validation process: + The WPF data binding model enables you to associate with your object. Validation occurs during binding target-to-binding source value transfer before the converter is called. The following describes the validation process: -1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that may have been added to the attached property of the bound element. It then checks if there are any custom s defined for that , in which case it calls the method on each of the s until one of them runs into an error or until all of them pass. +1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that may have been added to the attached property of the bound element. It then checks if there are any custom s defined for that , in which case it calls the method on each of the s until one of them runs into an error or until all of them pass. -2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. +2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. 3. If all of the rules pass, the binding engine then calls the converter, if one exists. 4. If the converter passes, the binding engine calls the setter of the source property. -5. If the binding has an associated with it and an exception is thrown during step 4, the binding engine checks to see if there is a . You have the option to use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. +5. If the binding has an associated with it and an exception is thrown during step 4, the binding engine checks to see if there is a . You have the option to use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. - Also note that a valid value transfer in either direction (target-to-source or source-to-target) clears the . attached property. + Also note that a valid value transfer in either direction (target-to-source or source-to-target) clears the . attached property. For more information, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -157,7 +157,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate|, constrained by | +|Delegate|, constrained by | ]]> @@ -217,27 +217,27 @@ ## Remarks The application cannot modify the content of this collection. See the Example section for an example of how to use this attached property. - The WPF data binding model enables you to associate with your object. Validation occurs during binding target-to-binding source value transfer before the converter is called. The following describes the validation process: + The WPF data binding model enables you to associate with your object. Validation occurs during binding target-to-binding source value transfer before the converter is called. The following describes the validation process: -1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that may have been added to the attached property of the bound element. It then checks if there are any custom s defined for that , in which case it calls the method on each of the s until one of them runs into an error or until all of them pass. +1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that may have been added to the attached property of the bound element. It then checks if there are any custom s defined for that , in which case it calls the method on each of the s until one of them runs into an error or until all of them pass. -2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. +2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. 3. If all of the rules pass, the binding engine then calls the converter, if one exists. 4. If the converter passes, the binding engine calls the setter of the source property. -5. If the binding has an associated with it and an exception is thrown during step 4, the binding engine checks to see if there is a . You have the option to use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. +5. If the binding has an associated with it and an exception is thrown during step 4, the binding engine checks to see if there is a . You have the option to use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. - Also note that a valid value transfer in either direction (target-to-source or source-to-target) clears the . attached property. + Also note that a valid value transfer in either direction (target-to-source or source-to-target) clears the . attached property. - For information about the behavior of this property in scenarios, see . + For information about the behavior of this property in scenarios, see . For more information, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). ## XAML Text Usage - See Remarks. The collection itself is not user settable, but you can use it in a control template definition in XAML. + See Remarks. The collection itself is not user settable, but you can use it in a control template definition in XAML. ## Dependency Property Information @@ -245,7 +245,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -304,7 +304,7 @@ with your object. If the user enters an invalid value, you may want to provide some feedback about the error on the application user interface (UI). One way to provide such feedback is to set the . attached property to a custom . + The WPF data binding model allows you to associate with your object. If the user enters an invalid value, you may want to provide some feedback about the error on the application user interface (UI). One way to provide such feedback is to set the . attached property to a custom . For a detailed discussion of validation, see the Data Validation section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -314,7 +314,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -560,7 +560,7 @@ scenarios, see . + For information about the behavior of this property in scenarios, see . For a detailed discussion of validation, see the Data Validation section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -570,7 +570,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -641,7 +641,7 @@ object stays invalid until is called or another transfer to the binding source validates successfully. + The object stays invalid until is called or another transfer to the binding source validates successfully. ]]> @@ -810,13 +810,13 @@ and attached properties reference each other, and you can set either one. For example, suppose that a displays validation errors that occur on a data-bound . You can do one of the following to establish that relationship: + The and attached properties reference each other, and you can set either one. For example, suppose that a displays validation errors that occur on a data-bound . You can do one of the following to establish that relationship: -- Set for the to the . +- Set for the to the . -- Set for the to the . +- Set for the to the . -- When you set one of the properties, the other property is set to the element on which you set the attached property; regardless of which of the previous options you choose, the for the is the and the for the is the . +- When you set one of the properties, the other property is set to the element on which you set the attached property; regardless of which of the previous options you choose, the for the is the and the for the is the . ## Dependency Property Information @@ -829,7 +829,7 @@ ## Examples - The following example uses a as the adorner site for the validation errors that occur on items in an . The example sets the for each item container in the to the label. The example uses the property to get the item container that has the error and binds the of the to the first that is reported. + The following example uses a as the adorner site for the validation errors that occur on items in an . The example sets the for each item container in the to the label. The example uses the property to get the item container that has the error and binds the of the to the first that is reported. :::code language="xml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetitembindinggroup"::: :::code language="xml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetvalidationadornersitefor"::: @@ -863,13 +863,13 @@ and attached properties reference each other, and you can set either one. For example, suppose that a displays validation errors that occur on a data bound . You can do one of the following to establish that relationship: + The and attached properties reference each other, and you can set either one. For example, suppose that a displays validation errors that occur on a data bound . You can do one of the following to establish that relationship: -- Set for the to the . +- Set for the to the . -- Set for the to the . +- Set for the to the . - When you set one of the properties, the other property is set to the element on which you set the attached property; regardless of which of the previous options you choose, the for the is the and the for the is the . + When you set one of the properties, the other property is set to the element on which you set the attached property; regardless of which of the previous options you choose, the for the is the and the for the is the . ## Dependency Property Information @@ -882,7 +882,7 @@ ## Examples - The following example uses a as the adorner site for the validation errors that occur on items in an . The example sets the for each item container in the to the label. The example uses the property to get the item container that has the error and binds the of the to the first that is reported. + The following example uses a as the adorner site for the validation errors that occur on items in an . The example sets the for each item container in the to the label. The example uses the property to get the item container that has the error and binds the of the to the first that is reported. :::code language="xml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetitembindinggroup"::: :::code language="xml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml" id="Snippetvalidationadornersitefor"::: diff --git a/xml/System.Windows.Controls/ValidationError.xml b/xml/System.Windows.Controls/ValidationError.xml index 9cfbe16725d..6e1b2703883 100644 --- a/xml/System.Windows.Controls/ValidationError.xml +++ b/xml/System.Windows.Controls/ValidationError.xml @@ -29,22 +29,22 @@ ## Remarks The WPF data binding model enables you to associate validation rules with your object. Validation occurs during target-to-source value transfer before the converter is called. The following describes the validation process. -1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that might have been added to the attached property of the bound element. It then checks whether any custom validation rules are defined for that , in which case it calls the method on each until one of them fails or until all of them pass. +1. When a value is being transferred from the target property to the source property, the data binding engine first removes any that might have been added to the attached property of the bound element. It then checks whether any custom validation rules are defined for that , in which case it calls the method on each until one of them fails or until all of them pass. -2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. +2. Once there is a custom rule that does not pass, the binding engine creates a object and adds it to the collection of the bound element. When is not empty, the attached property of the element is set to `true`. Also, if the property of the is set to `true`, then the binding engine raises the attached event on the element. 3. If all the rules pass, the binding engine then calls the converter, if one exists. 4. If the converter passes, the binding engine calls the setter of the source property. -5. If the binding has an associated with it and an exception is thrown during step 3 or 4, the binding engine checks to see if there is an . You can use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. +5. If the binding has an associated with it and an exception is thrown during step 3 or 4, the binding engine checks to see if there is an . You can use the callback to provide a custom handler for handling exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. - A valid value transfer in either direction (target to source or source to target) will clear the attached property. + A valid value transfer in either direction (target to source or source to target) will clear the attached property. ## Examples - The following example shows a style trigger that creates a that reports a validation error message. The attached property returns a collection of objects on the bound element. + The following example shows a style trigger that creates a that reports a validation error message. The attached property returns a collection of objects on the bound element. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/DataBindingLabApp.xaml" id="Snippet14"::: @@ -219,7 +219,7 @@ ## Examples - The following example shows a style trigger that creates a that reports a validation error message. The attached property returns a collection of objects on the bound element. + The following example shows a style trigger that creates a that reports a validation error message. The attached property returns a collection of objects on the bound element. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/DataBindingLabApp.xaml" id="Snippet14"::: diff --git a/xml/System.Windows.Controls/ValidationResult.xml b/xml/System.Windows.Controls/ValidationResult.xml index 37edb29b872..3db04722876 100644 --- a/xml/System.Windows.Controls/ValidationResult.xml +++ b/xml/System.Windows.Controls/ValidationResult.xml @@ -27,7 +27,7 @@ with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. + The WPF data binding model enables you to associate with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. For a detailed discussion of the validation process, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -83,7 +83,7 @@ with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. + The WPF data binding model enables you to associate with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. For a detailed discussion of the validation process, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -178,7 +178,7 @@ with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. + The WPF data binding model enables you to associate with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. For a detailed discussion of the validation process, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -262,7 +262,7 @@ with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. + The WPF data binding model enables you to associate with your or object. You can create custom rules by subclassing the class and implementing the method. The method returns a object to report whether the checked value is valid. For a detailed discussion of the validation process, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). diff --git a/xml/System.Windows.Controls/ValidationRule.xml b/xml/System.Windows.Controls/ValidationRule.xml index 0a72d785a1f..1bec8d561bf 100644 --- a/xml/System.Windows.Controls/ValidationRule.xml +++ b/xml/System.Windows.Controls/ValidationRule.xml @@ -27,7 +27,7 @@ with your binding object. To create custom rules, make a subclass of this class and implement the method. Optionally, use the built-in , which catches exceptions that are thrown during source updates, or the , which checks for errors raised by the implementation of the source object. + When you use the WPF data binding model, you can associate with your binding object. To create custom rules, make a subclass of this class and implement the method. Optionally, use the built-in , which catches exceptions that are thrown during source updates, or the , which checks for errors raised by the implementation of the source object. The binding engine checks each that is associated with a binding every time it transfers an input value, which is the binding target property value, to the binding source property. @@ -175,7 +175,7 @@ ## Remarks You must implement this method when you create a subclass of the class in order to create a custom validation rule. - Each time the data binding engine transfers a value from the binding target property (from user input) to the binding source property (the underlying data), it checks whether any are defined for that binding. If are defined for the binding, the engine calls the method on each until one of them finds an error or until all of them pass. + Each time the data binding engine transfers a value from the binding target property (from user input) to the binding source property (the underlying data), it checks whether any are defined for that binding. If are defined for the binding, the engine calls the method on each until one of them finds an error or until all of them pass. For detailed information about data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -308,7 +308,7 @@ is empty. The , `ValueIsNotNull`, has set to `true`, so that when the application starts, the runs and displays a message if the is empty. + The following example checks whether the is empty. The , `ValueIsNotNull`, has set to `true`, so that when the application starts, the runs and displays a message if the is empty. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetvalidatesontargetupdated"::: @@ -361,7 +361,7 @@ to on the called `ValidateDateAndPrice` so that when it runs, the method has access to values that are of the source property's type. When the rules `PriceIsAPositiveNumber` and `FutureDateRule` run, the values in each method are strings because the rules run before the values are converted to their respective types. + The following example sets the to on the called `ValidateDateAndPrice` so that when it runs, the method has access to values that are of the source property's type. When the rules `PriceIsAPositiveNumber` and `FutureDateRule` run, the values in each method are strings because the rules run before the values are converted to their respective types. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetwindowlayout"::: diff --git a/xml/System.Windows.Controls/ValidationStep.xml b/xml/System.Windows.Controls/ValidationStep.xml index bce5a5926a8..730d9b256c5 100644 --- a/xml/System.Windows.Controls/ValidationStep.xml +++ b/xml/System.Windows.Controls/ValidationStep.xml @@ -23,20 +23,20 @@ Specifies when a runs. - for this rule is set to `ConvertedProposedValue` so that when it runs, the method has access to values that are of the source property's type. - - When the `PriceIsAPositiveNumber` and `FutureDateRule` rules run, the values in each method are strings because the default value of is `RawProposedValue`. Therefore, the rules run before the values are converted to their respective types. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetwindowlayout"::: - - The following example shows the `ValidateDateAndPrice` validation rule. In the method, the `Price` property is of type , and the `OfferExpires` property is of type . The strings have been converted to their respective types by the time the `ValidationRule` runs. - + for this rule is set to `ConvertedProposedValue` so that when it runs, the method has access to values that are of the source property's type. + + When the `PriceIsAPositiveNumber` and `FutureDateRule` rules run, the values in each method are strings because the default value of is `RawProposedValue`. Therefore, the rules run before the values are converted to their respective types. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetwindowlayout"::: + + The following example shows the `ValidateDateAndPrice` validation rule. In the method, the `Price` property is of type , and the `OfferExpires` property is of type . The strings have been converted to their respective types by the time the `ValidationRule` runs. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Data.cs" id="Snippetvalidateobject"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/data.vb" id="Snippetvalidateobject"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/data.vb" id="Snippetvalidateobject"::: + ]]> diff --git a/xml/System.Windows.Controls/Viewbox.xml b/xml/System.Windows.Controls/Viewbox.xml index 2bc9e009c90..b5e915d284e 100644 --- a/xml/System.Windows.Controls/Viewbox.xml +++ b/xml/System.Windows.Controls/Viewbox.xml @@ -28,7 +28,7 @@ can only have one . If you add an additional , you cause an at run time. + A can only have one . If you add an additional , you cause an at run time. @@ -110,7 +110,7 @@ always sets its to the . It then computes and applies a transformation from that to the available space. determines available space by subtracting the margin of its from the input of its elements. + always sets its to the . It then computes and applies a transformation from that to the available space. determines available space by subtracting the margin of its from the input of its elements. ]]> @@ -311,7 +311,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -366,7 +366,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Controls/Viewport3D.xml b/xml/System.Windows.Controls/Viewport3D.xml index 9db0a5db885..d91dfde3016 100644 --- a/xml/System.Windows.Controls/Viewport3D.xml +++ b/xml/System.Windows.Controls/Viewport3D.xml @@ -44,9 +44,9 @@ ## Remarks The element renders 3-D content while providing features consistent with objects including 2-D layout, clipping, and input events. - When this element is included as the content of a layout element like , specify the size of the by setting its and properties (inherited from ). + When this element is included as the content of a layout element like , specify the size of the by setting its and properties (inherited from ). - extends 2-D hit testing into the 3-D scene by extruding the 2-D hit test point into a 3-D ray. Call the method to return detailed hit result information about the hit visual, model, mesh, and point of intersection. + extends 2-D hit testing into the 3-D scene by extruding the 2-D hit test point into a 3-D ray. Call the method to return detailed hit result information about the hit visual, model, mesh, and point of intersection. On Microsoft Windows XP, if the display color quality is not set to 32-bit or 16-bit, the might not render as expected. diff --git a/xml/System.Windows.Controls/VirtualizationCacheLength.xml b/xml/System.Windows.Controls/VirtualizationCacheLength.xml index eaf9725a7ad..fd099451ccf 100644 --- a/xml/System.Windows.Controls/VirtualizationCacheLength.xml +++ b/xml/System.Windows.Controls/VirtualizationCacheLength.xml @@ -36,7 +36,7 @@ attached property specifies the amount of space in which a virtualizes the items before or after the view port (the area in which items are visible). You can specify uniform cache length my creating a by using the constructor that takes a single parameter. You can use the constructor that takes two parameters to specify different values for the and properties. + The attached property specifies the amount of space in which a virtualizes the items before or after the view port (the area in which items are visible). You can specify uniform cache length my creating a by using the constructor that takes a single parameter. You can use the constructor that takes two parameters to specify different values for the and properties. ]]> @@ -414,7 +414,7 @@ method returns a string that displays the values of the and properties. + The method returns a string that displays the values of the and properties. ]]> diff --git a/xml/System.Windows.Controls/VirtualizationCacheLengthConverter.xml b/xml/System.Windows.Controls/VirtualizationCacheLengthConverter.xml index 019ba133341..ffd0f2f9050 100644 --- a/xml/System.Windows.Controls/VirtualizationCacheLengthConverter.xml +++ b/xml/System.Windows.Controls/VirtualizationCacheLengthConverter.xml @@ -82,31 +82,31 @@ if the can convert the specified type to a ; otherwise, . - can convert the following types to a : - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - + can convert the following types to a : + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + ]]> @@ -144,11 +144,11 @@ if the can convert a to the specified type; otherwise, . - method returns `true` if `destinationType` is or . Otherwise, returns `false`. - + method returns `true` if `destinationType` is or . Otherwise, returns `false`. + ]]> @@ -187,40 +187,40 @@ Converts the specified object to a . The converted object. - can convert the following types to a : - -- - -- - -- - -- - -- - -- - -- - -- - -- - -- - - Call the method before calling the to avoid throwing an exception. - + can convert the following types to a : + +- + +- + +- + +- + +- + +- + +- + +- + +- + +- + + Call the method before calling the to avoid throwing an exception. + ]]> - is . - - -or- - + is . + + -or- + cannot be converted to a . @@ -266,20 +266,20 @@ Converts the specified to an object of the specified type. The converted object. - method before calling the to avoid throwing an exception. - + method before calling the to avoid throwing an exception. + ]]> is . - is . - - -or- - + is . + + -or- + is not a . diff --git a/xml/System.Windows.Controls/VirtualizationCacheLengthUnit.xml b/xml/System.Windows.Controls/VirtualizationCacheLengthUnit.xml index 7d4c1b9b0d4..f3485bb34cb 100644 --- a/xml/System.Windows.Controls/VirtualizationCacheLengthUnit.xml +++ b/xml/System.Windows.Controls/VirtualizationCacheLengthUnit.xml @@ -22,11 +22,11 @@ Specifies the type of unit that is used by the attached property. - attached property to specify the units of the . - + attached property to specify the units of the . + ]]> diff --git a/xml/System.Windows.Controls/VirtualizationMode.xml b/xml/System.Windows.Controls/VirtualizationMode.xml index 4b8d215738a..ef1040b9529 100644 --- a/xml/System.Windows.Controls/VirtualizationMode.xml +++ b/xml/System.Windows.Controls/VirtualizationMode.xml @@ -26,7 +26,7 @@ creates an item container for each visible item and discards it when it is no longer needed (such as when the item is scrolled out of view). When an contains a many items, the process of creating and discarding item containers can negatively affect performance. When is set to Recycling, the reuses item containers instead of creating a new one each time. + By default, a creates an item container for each visible item and discards it when it is no longer needed (such as when the item is scrolled out of view). When an contains a many items, the process of creating and discarding item containers can negatively affect performance. When is set to Recycling, the reuses item containers instead of creating a new one each time. When cannot recycle item containers, it uses the standard mode of virtualization, which is to create and discard item containers for each item. The following list describes cases when the cannot recycle item containers: @@ -37,7 +37,7 @@ ## Examples - The following example creates a and sets the attached property to Recycling. + The following example creates a and sets the attached property to Recycling. :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/ItemContainerStyle/Window1.xaml" id="Snippetvirtualizationmode"::: diff --git a/xml/System.Windows.Controls/VirtualizingPanel.xml b/xml/System.Windows.Controls/VirtualizingPanel.xml index 6827014c8e0..187372f62ae 100644 --- a/xml/System.Windows.Controls/VirtualizingPanel.xml +++ b/xml/System.Windows.Controls/VirtualizingPanel.xml @@ -35,7 +35,7 @@ - You explicitly create the item containers to the . For more information about explicitly versus implicitly creating item containers, see the class. - When a is virtualizing item containers, you may need to save state information that is associated with a container instead of with the data item itself. For example, if an item is contained by an control, the state is bound to the item container, and not to the data item itself. When the is reused for a new item, the current value of is used for the new item. In addition, the old item does not retain its value. + When a is virtualizing item containers, you may need to save state information that is associated with a container instead of with the data item itself. For example, if an item is contained by an control, the state is bound to the item container, and not to the data item itself. When the is reused for a new item, the current value of is used for the new item. In addition, the old item does not retain its value. @@ -113,7 +113,7 @@ elements that virtualize their child collection than does the method. + This method offers better performance for elements that virtualize their child collection than does the method. ]]> @@ -206,7 +206,7 @@ property determines the unit of measurement that is used by . + The cache is the amount of space above or below the viewport in which items are not virtualized. Use a cache to avoid generating UI elements as they're scrolled into view. The property determines the unit of measurement that is used by . ]]> @@ -325,7 +325,7 @@ . + This method calls . ]]> @@ -472,7 +472,7 @@ attached property `true`. + The default is of the attached property `true`. ]]> @@ -591,7 +591,7 @@ . + This method calls . ]]> @@ -742,7 +742,7 @@ elements that virtualize their child collection than does the method. + This method offers better performance for elements that virtualize their child collection than does the method. ]]> @@ -841,7 +841,7 @@ ## Examples -The following example shows how to bind to an XML data source and virtualize the items displayed in a element by using XAML. Notice that the attached property is explicitly set to `true`. +The following example shows how to bind to an XML data source and virtualize the items displayed in a element by using XAML. Notice that the attached property is explicitly set to `true`. :::code language="xml" source="~/snippets/csharp/System.Windows.Controls/VirtualizingPanel/Overview/default.xaml" id="Snippet2"::: @@ -1061,7 +1061,7 @@ The following example shows how to bind to an XML data source and virtualize the elements that virtualize their child collection than does the method. + This method offers better performance for elements that virtualize their child collection than does the method. ]]> @@ -1151,7 +1151,7 @@ The following example shows how to bind to an XML data source and virtualize the property determines the unit of measurement that is used by . + The cache is the amount of space above or below the viewport in which items are not virtualized. Use a cache to avoid generating UI elements as they're scrolled into view. The property determines the unit of measurement that is used by . ]]> @@ -1454,12 +1454,12 @@ The following example shows how to bind to an XML data source and virtualize the creates an item container for each visible item and discards it when it is no longer needed (such as when the item is scrolled out of view). When an contains a lot of items, the process of creating and discarding item containers can negatively affect performance. When is set to , the reuses item containers instead of creating a new one each time. + By default, a creates an item container for each visible item and discards it when it is no longer needed (such as when the item is scrolled out of view). When an contains a lot of items, the process of creating and discarding item containers can negatively affect performance. When is set to , the reuses item containers instead of creating a new one each time. ## Examples - The following example creates a and sets the attached property to . + The following example creates a and sets the attached property to . :::code language="xml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/ItemContainerStyle/Window1.xaml" id="Snippetvirtualizationmode"::: diff --git a/xml/System.Windows.Controls/VirtualizingStackPanel.xml b/xml/System.Windows.Controls/VirtualizingStackPanel.xml index 4e9b1ab0813..691bb81a5a6 100644 --- a/xml/System.Windows.Controls/VirtualizingStackPanel.xml +++ b/xml/System.Windows.Controls/VirtualizingStackPanel.xml @@ -169,7 +169,7 @@ and methods in a derived class for custom layout behavior. + You can override the and methods in a derived class for custom layout behavior. ]]> @@ -1026,7 +1026,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the mouse wheel down action. + You can override in a derived class to change how the stack panel responds to the mouse wheel down action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1067,7 +1067,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the mouse wheel left action. + You can override in a derived class to change how the stack panel responds to the mouse wheel left action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1108,7 +1108,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the mouse wheel right action. + You can override in a derived class to change how the stack panel responds to the mouse wheel right action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1149,7 +1149,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the mouse wheel up action. + You can override in a derived class to change how the stack panel responds to the mouse wheel up action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1428,7 +1428,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1495,7 +1495,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the page down action. + You can override in a derived class to change how the stack panel responds to the page down action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1536,7 +1536,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the page left action. + You can override in a derived class to change how the stack panel responds to the page left action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1577,7 +1577,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the page right action. + You can override in a derived class to change how the stack panel responds to the page right action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1618,7 +1618,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. in a derived class to change how the stack panel responds to the page up action. + You can override in a derived class to change how the stack panel responds to the page up action. If you require physical scrolling instead of logical scrolling, wrap the in a and set its property to `false`. In this case, the provides scrolling, and virtualization is disabled. @@ -1706,7 +1706,7 @@ Notice that the IsVirtualizing attached property is explicitly set to `true`. control is the , physical scrolling is enabled. If a is the , scrolling is logical by child element. + If a control is the , physical scrolling is enabled. If a is the , scrolling is logical by child element. ]]> diff --git a/xml/System.Windows.Controls/WebBrowser.xml b/xml/System.Windows.Controls/WebBrowser.xml index ded4ddae184..73f524c89cd 100644 --- a/xml/System.Windows.Controls/WebBrowser.xml +++ b/xml/System.Windows.Controls/WebBrowser.xml @@ -39,13 +39,13 @@ ## Remarks The control provides the following capabilities: - **Navigation**: , , , , and . + **Navigation**: , , , , and . **Navigation Lifetime**: , , and . - **Navigation Journaling**: , , , and . + **Navigation Journaling**: , , , and . - **WPF/HTML Interoperability**: and , and . + **WPF/HTML Interoperability**: and , and . is bound by the security constraints of the WPF application that is hosting the : @@ -197,7 +197,7 @@ internal interface IServiceProvider . The example first checks that there are documents to navigate back to by checking . + The following example shows how to navigate back to the previous document by calling . The example first checks that there are documents to navigate back to by checking . ```csharp private void backButton_Click(object sender, RoutedEventArgs e) @@ -246,7 +246,7 @@ private void backButton_Click(object sender, RoutedEventArgs e) . The example first checks that there are documents to navigate forward to by checking . + The following example shows how to navigate forward to the next HTML document by calling . The example first checks that there are documents to navigate forward to by checking . ```csharp private void forwardButton_Click(object sender, RoutedEventArgs e) @@ -345,12 +345,12 @@ private void forwardButton_Click(object sender, RoutedEventArgs e) and there are not any documents to navigate back to, does not perform a navigation and an exception is thrown. If you need to, you can inspect the value of the property to determine whether there are documents to navigate back to. + If you call and there are not any documents to navigate back to, does not perform a navigation and an exception is thrown. If you need to, you can inspect the value of the property to determine whether there are documents to navigate back to. ## Examples - The following example shows how to navigate back to the previous HTML document by calling . The example first checks that there are HTML documents to navigate back to by checking . + The following example shows how to navigate back to the previous HTML document by calling . The example first checks that there are HTML documents to navigate back to by checking . ```csharp private void backButton_Click(object sender, RoutedEventArgs e) @@ -408,12 +408,12 @@ private void backButton_Click(object sender, RoutedEventArgs e) and there are not any documents to navigate forward to, does not perform a navigation and an exception is thrown. If you need to, you can inspect the value of the property to determine whether there are documents to navigate forward to. + If you call and there are not any documents to navigate forward to, does not perform a navigation and an exception is thrown. If you need to, you can inspect the value of the property to determine whether there are documents to navigate forward to. ## Examples - The following example shows how to navigate forward to the next document by calling . The example first checks that there are documents to navigate forward to by checking . + The following example shows how to navigate forward to the next document by calling . The example first checks that there are documents to navigate forward to by checking . ```csharp private void forwardButton_Click(object sender, RoutedEventArgs e) @@ -484,12 +484,12 @@ private void forwardButton_Click(object sender, RoutedEventArgs e) should not be called before the document that implements it has finished loading. You can detect when a document has finished loading by handling the event. + should not be called before the document that implements it has finished loading. You can detect when a document has finished loading by handling the event. ## Examples - The following example shows how to call a script function in a document from a WPF application by using . In this example, the script function has no parameters. + The following example shows how to call a script function in a document from a WPF application by using . In this example, the script function has no parameters. The following is the HTML document that implements the script function that will be called from WPF. @@ -593,14 +593,14 @@ private void callScriptFunctionNoParamButton_Click(object sender, RoutedEventArg should not be called before the document that implements it has finished loading. You can detect when a document has finished loading by handling the event. + should not be called before the document that implements it has finished loading. You can detect when a document has finished loading by handling the event. If you do not pass enough parameter values to the script that you are invoking, the parameters that you do not pass values to will have the undefined value. If you pass too many parameter values, the excess values are ignored. ## Examples - The following example shows how to call script functions in a document from an application by using . In this example, the script functions require parameters. + The following example shows how to call script functions in a document from an application by using . In this example, the script functions require parameters. The following is the document that implements the script functions that will be called from WPF. @@ -742,7 +742,7 @@ private void callScriptFunctionNoParamButton_Click(object sender, RoutedEventArg method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. + Use the method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. ]]> @@ -787,14 +787,14 @@ private void callScriptFunctionNoParamButton_Click(object sender, RoutedEventArg has the same effect as setting the property. is used from markup by developers who want to declaratively specify the initial document that navigates to when is initialized. + Calling has the same effect as setting the property. is used from markup by developers who want to declaratively specify the initial document that navigates to when is initialized. - Use the method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. + Use the method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. ## Examples - The following example shows how to use to navigate to a document by using the method. + The following example shows how to use to navigate to a document by using the method. ```xaml @@ -869,7 +869,7 @@ private void goNavigateButton_Click(object sender, RoutedEventArgs e) method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. + Use the method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. ]]> @@ -914,7 +914,7 @@ private void goNavigateButton_Click(object sender, RoutedEventArgs e) method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. + Use the method to navigate to a URL that may include escape characters. Use the method to navigate to a that does not include escape characters. @@ -1037,7 +1037,7 @@ private void goNavigateButton_Click(object sender, RoutedEventArgs e) If the stream parameter is not in a valid HTML format, it will be displayed as plain text. - After navigation, will be `null`. + After navigation, will be `null`. @@ -1100,7 +1100,7 @@ private void goNavigateToStreamButton_Click(object sender, RoutedEventArgs e) If the text parameter is not in valid HTML format, it will be displayed as plain text. - After navigation, will be `null`. + After navigation, will be `null`. diff --git a/xml/System.Windows.Controls/WrapPanel.xml b/xml/System.Windows.Controls/WrapPanel.xml index 92e1dc01db2..2b0baebe685 100644 --- a/xml/System.Windows.Controls/WrapPanel.xml +++ b/xml/System.Windows.Controls/WrapPanel.xml @@ -28,7 +28,7 @@ contains a collection of objects, which are in the property. All child elements of a receive the layout partition size of multiplied by . + A contains a collection of objects, which are in the property. All child elements of a receive the layout partition size of multiplied by . @@ -143,7 +143,7 @@ ## Remarks If this property is not set (or if it is set to `Auto` in XAML or to `Double.NaN` in code), the size of the layout partition is equal to the desired size of the child element. - A child element of a may have its height property set explicitly. specifies the size of the layout partition that is reserved by the for the child element. As a result, takes precedence over an element's own height. + A child element of a may have its height property set explicitly. specifies the size of the layout partition that is reserved by the for the child element. As a result, takes precedence over an element's own height. ## XAML Attribute Usage @@ -183,7 +183,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -269,9 +269,9 @@ of the child element. + If this property is not set (or if it is set to `Auto` in Extensible Application Markup Language (XAML) or to `Double.NaN` in code), the size of the layout partition is equal to the of the child element. - A child element of a may have its width property set explicitly. specifies the size of the layout partition that is reserved by the for the child element. As a result, takes precedence over an element's own width. + A child element of a may have its width property set explicitly. specifies the size of the layout partition that is reserved by the for the child element. As a result, takes precedence over an element's own width. ## XAML Attribute Usage @@ -311,7 +311,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -439,7 +439,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| diff --git a/xml/System.Windows.Converters/Int32RectValueSerializer.xml b/xml/System.Windows.Converters/Int32RectValueSerializer.xml index a554fc361bd..b781769507e 100644 --- a/xml/System.Windows.Converters/Int32RectValueSerializer.xml +++ b/xml/System.Windows.Converters/Int32RectValueSerializer.xml @@ -24,11 +24,11 @@ Converts instances of to and from instances of . - for serialization purposes. - + for serialization purposes. + ]]> @@ -168,11 +168,11 @@ Converts a into a . A new instance of based on the supplied . - internally. - + internally. + ]]> diff --git a/xml/System.Windows.Converters/PointValueSerializer.xml b/xml/System.Windows.Converters/PointValueSerializer.xml index f3f9b9f2a8a..a0fc25b5e27 100644 --- a/xml/System.Windows.Converters/PointValueSerializer.xml +++ b/xml/System.Windows.Converters/PointValueSerializer.xml @@ -161,11 +161,11 @@ Converts a into a . A new instance of based on the supplied . - internally. - + internally. + ]]> diff --git a/xml/System.Windows.Converters/RectValueSerializer.xml b/xml/System.Windows.Converters/RectValueSerializer.xml index caae2f3caa7..8a458e033cc 100644 --- a/xml/System.Windows.Converters/RectValueSerializer.xml +++ b/xml/System.Windows.Converters/RectValueSerializer.xml @@ -24,11 +24,11 @@ Converts instances of to and from instances of . - for serialization purposes. - + for serialization purposes. + ]]> @@ -168,11 +168,11 @@ Converts a into a . A new instance of based on the supplied . - internally. - + internally. + ]]> diff --git a/xml/System.Windows.Converters/SizeValueSerializer.xml b/xml/System.Windows.Converters/SizeValueSerializer.xml index da28195d454..5b456d0a89d 100644 --- a/xml/System.Windows.Converters/SizeValueSerializer.xml +++ b/xml/System.Windows.Converters/SizeValueSerializer.xml @@ -24,11 +24,11 @@ Converts instances of to and from instances of . - for serialization purposes. - + for serialization purposes. + ]]> @@ -168,11 +168,11 @@ Converts a into a . A new instance of based on the supplied . - internally. - + internally. + ]]> diff --git a/xml/System.Windows.Converters/VectorValueSerializer.xml b/xml/System.Windows.Converters/VectorValueSerializer.xml index ef4ab6e5a46..cfbc2921ac4 100644 --- a/xml/System.Windows.Converters/VectorValueSerializer.xml +++ b/xml/System.Windows.Converters/VectorValueSerializer.xml @@ -24,11 +24,11 @@ Converts instances of to and from instances of . - for serialization purposes. - + for serialization purposes. + ]]> @@ -168,11 +168,11 @@ Converts a into a . A new instance of based on the supplied . - internally. - + internally. + ]]> diff --git a/xml/System.Windows.Data/Binding.xml b/xml/System.Windows.Data/Binding.xml index 2e2409239e1..f577f31ead7 100644 --- a/xml/System.Windows.Data/Binding.xml +++ b/xml/System.Windows.Data/Binding.xml @@ -35,7 +35,7 @@ The figure demonstrates the following fundamental WPF data binding concepts. -- Each binding typically has these four components: a binding target object, a target property, a binding source, and a to the value in the binding source to use. For example, if you want to bind the content of a to the Name property of an Employee object, your target object is the , the target property is the property, the value to use is Name, and the source object is the Employee object. +- Each binding typically has these four components: a binding target object, a target property, a binding source, and a to the value in the binding source to use. For example, if you want to bind the content of a to the Name property of an Employee object, your target object is the , the target property is the property, the value to use is Name, and the source object is the Employee object. - The target property must be a dependency property. This also means that you cannot bind a field. Most properties of objects are dependency properties and most dependency properties, except read-only ones, support data binding by default. (Only types can define dependency properties and all objects derive from .) @@ -289,7 +289,7 @@ objects. In this case, the binding engine evaluates the relative to the object obtained from the property. In addition, the binding listens for the event and reacts accordingly. Setting this property to `true` overrides this behavior and gives the binding access to properties of the object itself. + The normal behavior (when this property is `false`) includes special treatment for objects. In this case, the binding engine evaluates the relative to the object obtained from the property. In addition, the binding listens for the event and reacts accordingly. Setting this property to `true` overrides this behavior and gives the binding access to properties of the object itself. ]]> @@ -339,7 +339,7 @@ ## Remarks A binding implicitly uses a default converter that tries to do a type conversion between the source value and the target value. If a conversion cannot be made, the default converter returns `null`. - If you want to associate a custom value converter with a binding, you should create a class that implements the interface and supply implementations for the and methods. Value converters can change data from one type to another, translate between cultural details such as character sets, or modify other aspects of their presentation. For examples of typical conversion scenarios, see "Data Conversion" in the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + If you want to associate a custom value converter with a binding, you should create a class that implements the interface and supply implementations for the and methods. Value converters can change data from one type to another, translate between cultural details such as character sets, or modify other aspects of their presentation. For examples of typical conversion scenarios, see "Data Conversion" in the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). ## XAML Attribute Usage @@ -351,7 +351,7 @@ ## XAML Values *myConverter* - A resource reference to a class that implements the interface, which includes implementations of the and methods. To refer to a value converter, use the [StaticResource Markup Extension](/dotnet/framework/wpf/advanced/staticresource-markup-extension). + A resource reference to a class that implements the interface, which includes implementations of the and methods. To refer to a value converter, use the [StaticResource Markup Extension](/dotnet/framework/wpf/advanced/staticresource-markup-extension). ]]> @@ -449,7 +449,7 @@ property to specify how an object is converted. This property passes additional information to a converter that you use on a binding. When you specify a , the value is passed to the and methods as the `parameter` parameter. + You can use the property to specify how an object is converted. This property passes additional information to a converter that you use on a binding. When you specify a , the value is passed to the and methods as the `parameter` parameter. For an example, see [How to: Produce a Value Based on a List of Bound Items](/dotnet/framework/wpf/data/how-to-produce-a-value-based-on-a-list-of-bound-items). That example shows an implementation of an but the usage still applies. @@ -534,11 +534,11 @@ to control the height of another control in your application, or if you want to bind the of your control to the property of your control. + This property is useful when you want to bind to the property of another element in your application. For example, if you want to use a to control the height of another control in your application, or if you want to bind the of your control to the property of your control. By default, bindings inherit the data context specified by the `DataContext` property, if one has been set. However, the property is one of the ways you can explicitly set the source of a and override the inherited data context. For more information, see [How to: Specify the Binding Source](/dotnet/framework/wpf/data/how-to-specify-the-binding-source). - The and properties of the class also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict might occur. This property throws an exception if there is a binding source conflict. + The and properties of the class also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict might occur. This property throws an exception if there is a binding source conflict. ]]> @@ -578,11 +578,11 @@ attached property. + This method supports attached property usage for the attached property. XML namespace managers are relevant only if the data in the binding came from an XML binding source ( object). - If a namespace manager was not specifically applied either in the original data source creation or by subsequently calling on the binding, then this method will return `null`. + If a namespace manager was not specifically applied either in the original data source creation or by subsequently calling on the binding, then this method will return `null`. This method will always return `null` if the data behind the binding is not XML. @@ -659,9 +659,9 @@ property when the `get` accessor of your binding source property might take a long time. One example is an image property with a `get` accessor that downloads from the Web. Setting to `true` avoids blocking the UI while the download occurs. + Use the property when the `get` accessor of your binding source property might take a long time. One example is an image property with a `get` accessor that downloads from the Web. Setting to `true` avoids blocking the UI while the download occurs. - While waiting for the value to arrive, the binding reports the , if one is available, or the default value of the binding target property. + While waiting for the value to arrive, the binding reports the , if one is available, or the default value of the binding target property. However, there should not be many scenarios where you need to use the property. The .NET guidelines recommend against defining properties that are orders of magnitude slower than a field set would be. When you are creating your class, consider handling extremely slow operations outside of the `get` accessor and caching the result. @@ -713,7 +713,7 @@ ## Remarks To support and bindings, the underlying data must implement . For details, see [How to: Implement Property Change Notification](/dotnet/framework/wpf/data/how-to-implement-property-change-notification). - For or bindings, you can control the target-to-source updates by setting the property. For more information, see . + For or bindings, you can control the target-to-source updates by setting the property. For more information, see . For more information on the different binding modes, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -832,7 +832,7 @@ associated with it, the binding engine checks each rule each time it transfers the target property value to the source property. If a rule invalidates a value, the binding engine creates a object and adds it to the . collection of the bound object. When the property is not empty, the attached property of the object is set to `true`. If the property of the is set to `true`, then the binding engine raises the attached event on the object. + If the binding has associated with it, the binding engine checks each rule each time it transfers the target property value to the source property. If a rule invalidates a value, the binding engine creates a object and adds it to the . collection of the bound object. When the property is not empty, the attached property of the object is set to `true`. If the property of the is set to `true`, then the binding engine raises the attached event on the object. For a detailed discussion of the validation process, see the Data Validation section in the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -884,7 +884,7 @@ - Subproperties of a property can be specified by a syntax similar to that used in C#. For instance, the clause `Path=ShoppingCart.Order` sets the binding to the subproperty `Order` of the object or property `ShoppingCart`. -- To bind to an attached property, place parentheses around the attached property. For example, to bind to the attached property , the syntax is `Path=(DockPanel.Dock)`. +- To bind to an attached property, place parentheses around the attached property. For example, to bind to the attached property , the syntax is `Path=(DockPanel.Dock)`. - Indexers of a property can be specified within square brackets following the property name where the indexer is applied. For instance, the clause `Path=ShoppingCart[0]` sets the binding to the index that corresponds to how your property's internal indexing handles the literal string "0". Multiple indexers are also supported. @@ -959,7 +959,7 @@ By default, bindings inherit the data context specified by the `DataContext` property, if one has been set. However, the property is one of the ways you can explicitly set the source of a and override the inherited data context. For more information, see [How to: Specify the Binding Source](/dotnet/framework/wpf/data/how-to-specify-the-binding-source). - The and properties also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict can occur. This property throws an exception if there is a binding source conflict. + The and properties also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict can occur. This property throws an exception if there is a binding source conflict. For XAML information, see [RelativeSource MarkupExtension](/dotnet/framework/wpf/advanced/relativesource-markupextension). @@ -1092,7 +1092,7 @@ attached property. + This method supports attached property usage for the attached property. ]]> @@ -1264,7 +1264,7 @@ ## Remarks By default, bindings inherit the data context specified by the `DataContext` property, if one has been set. However, the property is one of the ways you can explicitly set the source of a and override the inherited data context. If you do not need the functionality of establishing a scope in which several properties inherit the same data context, you can use the property instead of the `DataContext` property. - The and properties also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict can occur. This property throws an exception if there is a binding source conflict. + The and properties also enable you to set the source of the binding explicitly. However, only one of the three properties, , , and , should be set for each binding, or a conflict can occur. This property throws an exception if there is a binding source conflict. To clear this property, set it to . @@ -1289,7 +1289,7 @@ The highlighted line that contains the `` elements shows how to bind to the `PersonName` property. As a result, the control appears with the value "Joe". - In the following example, the values of the objects are set to the `static` property : + In the following example, the values of the objects are set to the `static` property : :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetcomboboxmultibinding"::: @@ -1330,7 +1330,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate|, constrained to .| +|Delegate|, constrained to .| ]]> @@ -1399,7 +1399,7 @@ |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate|, constrained to .| +|Delegate|, constrained to .| ]]> @@ -1479,7 +1479,7 @@ is a built-in validation rule that checks for exceptions thrown during the update of the binding source property. If you have associated the with your object, you can use this property to set a handler to provide custom logic for handling these exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. + The is a built-in validation rule that checks for exceptions thrown during the update of the binding source property. If you have associated the with your object, you can use this property to set a handler to provide custom logic for handling these exceptions. If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. @@ -1542,9 +1542,9 @@ or listen for changes in the target property and propagate them back to the source. This is known as updating the source. Usually, these updates happen whenever the target property changes. This is fine for check boxes and other simple controls, but it is usually not appropriate for text fields. Updating after every keystroke can diminish performance and it denies the user the usual opportunity to backspace and fix typing errors before committing to the new value. Therefore, the default value of the property is and not . + Bindings that are or listen for changes in the target property and propagate them back to the source. This is known as updating the source. Usually, these updates happen whenever the target property changes. This is fine for check boxes and other simple controls, but it is usually not appropriate for text fields. Updating after every keystroke can diminish performance and it denies the user the usual opportunity to backspace and fix typing errors before committing to the new value. Therefore, the default value of the property is and not . - If you set the value to , you must call the method or the changes will not propagate back to the source. + If you set the value to , you must call the method or the changes will not propagate back to the source. ]]> @@ -1588,19 +1588,19 @@ element explicitly. The is a built-in validation rule that checks for errors that are raised by the implementation of the source object. If an error is raised, the binding engine creates a with the error and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. + Setting this property provides an alternative to using the element explicitly. The is a built-in validation rule that checks for errors that are raised by the implementation of the source object. If an error is raised, the binding engine creates a with the error and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. - is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Examples - The following examples uses and to validate user input in a . The first example creates a data type that implements to report validation errors. + The following examples uses and to validate user input in a . The first example creates a data type that implements to report validation errors. :::code language="csharp" source="~/snippets/csharp/System.Windows.Data/Binding/ValidatesOnDataErrors/data.cs" id="Snippetidataerrorinfodata"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/Binding/ValidatesOnDataErrors/window1.xaml.vb" id="Snippetidataerrorinfodata"::: - The following example binds the `Age` property to the and sets to `true` on the . When the user enters an invalid value, a red border appears in the and the reports the error message. + The following example binds the `Age` property to the and sets to `true` on the . When the user enters an invalid value, a red border appears in the and the reports the error message. :::code language="xaml" source="~/snippets/csharp/System.Windows.Data/Binding/ValidatesOnDataErrors/window1.xaml" id="Snippetidataerrorinfoxaml"::: @@ -1646,19 +1646,19 @@ element explicitly. The is a built-in validation rule that checks for exceptions that are thrown during the update of the source property. If an exception is thrown, the binding engine creates a with the exception and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. + Setting this property provides an alternative to using the element explicitly. The is a built-in validation rule that checks for exceptions that are thrown during the update of the source property. If an exception is thrown, the binding engine creates a with the exception and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. - is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Examples - The following examples use to validate user input in a . The first example creates a data type that throws an exception when the `Age` property is set to an invalid property. + The following examples use to validate user input in a . The first example creates a data type that throws an exception when the `Age` property is set to an invalid property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Data/Binding/ValidatesOnDataErrors/data.cs" id="Snippetthrowexceptiondata"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/Binding/ValidatesOnDataErrors/window1.xaml.vb" id="Snippetthrowexceptiondata"::: - The following example binds the `Age` property to the and sets to `true` on the . When the user enters an invalid value, a red border appears in the and the reports the error message. + The following example binds the `Age` property to the and sets to `true` on the . When the user enters an invalid value, a red border appears in the and the reports the error message. :::code language="xaml" source="~/snippets/csharp/System.Windows.Data/Binding/ValidatesOnDataErrors/window1.xaml" id="Snippetthrowexceptionxaml"::: @@ -1703,7 +1703,7 @@ is `true`, the binding checks for and reports errors that are raised by a data source that implements . + When is `true`, the binding checks for and reports errors that are raised by a data source that implements . ]]> @@ -1739,7 +1739,7 @@ with your or object. You can create custom rules by deriving from the class and implementing the method, or you can use the built-in , which invalidates a value if there are exceptions during source updates. + The WPF data binding model enables you to associate with your or object. You can create custom rules by deriving from the class and implementing the method, or you can use the built-in , which invalidates a value if there are exceptions during source updates. The binding engine checks each associated with a binding each time an input value (the binding target property value) is transferred to the binding source property. For a detailed discussion of the validation process, see the Data Validation section in the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -1801,7 +1801,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1879,7 +1879,7 @@ By setting the property, you are creating an `XPath` query to select a node or a collection of nodes ( and both derive from ). is a common language runtime (CLR) object, which means you can bind to its properties using the property. - The method handles the `XPath` expressions from the property. `XPath` functions are not supported. For `XPath` expression information, see the documentation and some examples provided in the Example section. + The method handles the `XPath` expressions from the property. `XPath` functions are not supported. For `XPath` expression information, see the documentation and some examples provided in the Example section. LINQ to XML objects and do not use `XPath`. For details, see [How to: Bind to XDocument, XElement, or LINQ for XML Query Results](/dotnet/framework/wpf/data/how-to-bind-to-xdocument-xelement-or-linq-for-xml-query-results). diff --git a/xml/System.Windows.Data/BindingBase.xml b/xml/System.Windows.Data/BindingBase.xml index 7eb4e15deaa..058dc34022d 100644 --- a/xml/System.Windows.Data/BindingBase.xml +++ b/xml/System.Windows.Data/BindingBase.xml @@ -38,7 +38,7 @@ method is sealed, a custom binding class that derives from will not function correctly as a Extensible Application Markup Language (XAML) markup extension. + Because the method is sealed, a custom binding class that derives from will not function correctly as a Extensible Application Markup Language (XAML) markup extension. ]]> @@ -84,29 +84,29 @@ is not set, the binding belongs to a only if the binding's source and the of the parent element that has the are the same object. + If is not set, the binding belongs to a only if the binding's source and the of the parent element that has the are the same object. - If is set to a value, the binding belongs to a if the following conditions are true: + If is set to a value, the binding belongs to a if the following conditions are true: -- The of the and are equal. +- The of the and are equal. - The belongs to a parent element of the binding's target element. - If is set to `null`, the binding is never a part of a . + If is set to `null`, the binding is never a part of a . - You can include bindings that have a source that is different from the of the parent element that has the by setting of the and the property of a binding to the same value. You can exclude bindings that have the same source as of the parent element that has the by setting of the and the property of a binding to different values. + You can include bindings that have a source that is different from the of the parent element that has the by setting of the and the property of a binding to the same value. You can exclude bindings that have the same source as of the parent element that has the by setting of the and the property of a binding to different values. ## Examples - The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which is data bound to a different source: The binding of the first is part of the because the inherits the and from its parent + The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which is data bound to a different source: The binding of the first is part of the because the inherits the and from its parent - The binding on the second is part of the because the of the and the of the are both set to `bindingGroup`. + The binding on the second is part of the because the of the and the of the are both set to `bindingGroup`. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetbindinggroupname"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetvalidationadornersite"::: - The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. + The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml.cs" id="Snippetbindinggroupnamevalidationrule"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window3.xaml.vb" id="Snippetbindinggroupnamevalidationrule"::: @@ -150,7 +150,7 @@ property to and the to . In this situation, you can use the property to specify whether there should be a time delay between when the target is changed and when the source is updated. This is useful when you want to enable users to change a property on a source object but you don't want each change to be immediately committed to the source. For example, suppose that you have a text box that is data two-way bound to a property of a data object. When the user changes the value in the text box, the source gets updated. To enable this scenario, you set the property on the to and the to . To avoid updating the source object with every keystroke, set the property to a reasonable value to cause the binding to update only after that amount of time has elapsed since the user stopped typing. + When you use a binding to update the binding source whenever the value of the property changes on the target, you set the property to and the to . In this situation, you can use the property to specify whether there should be a time delay between when the target is changed and when the source is updated. This is useful when you want to enable users to change a property on a source object but you don't want each change to be immediately committed to the source. For example, suppose that you have a text box that is data two-way bound to a property of a data object. When the user changes the value in the text box, the source gets updated. To enable this scenario, you set the property on the to and the to . To avoid updating the source object with every keystroke, set the property to a reasonable value to cause the binding to update only after that amount of time has elapsed since the user stopped typing. ]]> @@ -200,7 +200,7 @@ 3. The resulting value is valid for the binding target (target) property. - If 1 and 2 return , the target property is set to the value of the , if one is available. If there is no , the default value of the target property is used. + If 1 and 2 return , the target property is set to the value of the , if one is available. If there is no , the default value of the target property is used. The value is not considered a successful return value. @@ -270,7 +270,7 @@ The class implementation of this method is expected to return an expression object that is the result of a binding. Binding a property works by targeting a given on a given . These two pieces of information are transmitted by querying for an implementation on the `serviceProvider`, which the WPF XAML reader makes available during parsing of a binding. This base class implementation is responsible for checking for a valid and . If these are found, the actual implementation of returning a binding expression falls to various derived classes, as implemented by having the base class call an internal abstract method. Otherwise, the extension returns the binding object itself. Returning the binding itself results in a type mismatch error, but this should not occur under normal circumstances. > [!IMPORTANT] -> Because the syntax for binding through XAML as implemented in this method relies on implementing an internal override, and because itself is sealed, a custom binding class that derives from will not function correctly as a XAML markup extension. +> Because the syntax for binding through XAML as implemented in this method relies on implementing an internal override, and because itself is sealed, a custom binding class that derives from will not function correctly as a XAML markup extension. ]]> @@ -390,15 +390,15 @@ can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). + can be a predefined, composite, or custom string format. For more information about string formats, see [Formatting Types](/dotnet/standard/base-types/formatting-types). - If you set the and properties, the converter is applied to the data value first, and then the is applied. + If you set the and properties, the converter is applied to the data value first, and then the is applied. - When you set the on a to a composite string format, you can specify only one parameter. + When you set the on a to a composite string format, you can specify only one parameter. - When you use a , the property applies only when it is set on the . The value of that is set on any child objects is ignored. The number of parameters in a composite string format cannot exceed the number of child objects in the . + When you use a , the property applies only when it is set on the . The value of that is set on any child objects is ignored. The number of parameters in a composite string format cannot exceed the number of child objects in the . - When you use a , you can set the on the , on child binding objects, or both. If the is set on the child binding that is applied, that value is used. If the is not set on the child binding that is applied, the of the is applied if it is set. + When you use a , you can set the on the , on child binding objects, or both. If the is set on the child binding that is applied, that value is used. If the is not set on the child binding that is applied, the of the is applied if it is set. If the format string starts with the `{` character, the XAML parser will confuse it for a markup extension. To avoid this ambiguity, prefix the format string with an empty set of curly braces. diff --git a/xml/System.Windows.Data/BindingExpression.xml b/xml/System.Windows.Data/BindingExpression.xml index 6f8a1e7a6a2..58b034c6145 100644 --- a/xml/System.Windows.Data/BindingExpression.xml +++ b/xml/System.Windows.Data/BindingExpression.xml @@ -40,7 +40,7 @@ You can use the same `myBinding` object to create other bindings. For example, you might use the `myBinding` object to bind the text content of a check box to `MyDataProperty`. In that scenario, there will be two instances of that share the `myBinding` object. - You can obtain a object by using the method or the method on a data-bound object. + You can obtain a object by using the method or the method on a data-bound object. ]]> @@ -76,7 +76,7 @@ event handler that uses the method to obtain the and then calls the property to access the binding source object. + The following example shows the implementation of a event handler that uses the method to obtain the and then calls the property to access the binding source object. The `SavingsText` is the binding target object, and its property is the binding target property. @@ -243,9 +243,9 @@ of the binding is not or . + This method does nothing when the of the binding is not or . - If the value of your binding is set to , you must call the method or the changes will not propagate back to the source. + If the value of your binding is set to , you must call the method or the changes will not propagate back to the source. ]]> diff --git a/xml/System.Windows.Data/BindingExpressionBase.xml b/xml/System.Windows.Data/BindingExpressionBase.xml index 759d8c6f6d3..37710c6c1f2 100644 --- a/xml/System.Windows.Data/BindingExpressionBase.xml +++ b/xml/System.Windows.Data/BindingExpressionBase.xml @@ -455,14 +455,14 @@ method enables you to run validation rules on a binding without updating the source of the binding. This is useful when you want to validate user input and update the source at different times in an application. + The method enables you to run validation rules on a binding without updating the source of the binding. This is useful when you want to validate user input and update the source at different times in an application. - For example, suppose you have a form to update a data source that contains a submit button. You want to provide feedback to the user if an invalid value is entered before the user attempts to submit the form. You can check the validity of a field by setting the binding's property to and calling when the loses focus. + For example, suppose you have a form to update a data source that contains a submit button. You want to provide feedback to the user if an invalid value is entered before the user attempts to submit the form. You can check the validity of a field by setting the binding's property to and calling when the loses focus. ## Examples - The following example demonstrates the scenario that is discussed in the Remarks section. The example enables a user to enter data for a library item and submit the data. The binding for the named `callNum` has a associated with it. When the loses focus, the example calls . When the user clicks the submit button, the example calls to commit the changes. The following XAML creates the user interface for the application. + The following example demonstrates the scenario that is discussed in the Remarks section. The example enables a user to enter data for a library item and submit the data. The binding for the named `callNum` has a associated with it. When the loses focus, the example calls . When the user clicks the submit button, the example calls to commit the changes. The following XAML creates the user interface for the application. :::code language="xaml" source="~/snippets/csharp/System.Windows.Data/BindingExpressionBase/ValidateWithoutUpdate/window1.xaml" id="Snippetwindowxaml"::: diff --git a/xml/System.Windows.Data/BindingGroup.xml b/xml/System.Windows.Data/BindingGroup.xml index 81ee9c706f9..056216d3fef 100644 --- a/xml/System.Windows.Data/BindingGroup.xml +++ b/xml/System.Windows.Data/BindingGroup.xml @@ -31,15 +31,15 @@ You set the property on or . Child elements inherit the from their parent elements, just as with any other inheritable property. A binding on a descendent element is added to a if one of the following situations occurs: -- The binding's source and the of the element that has the are the same object and the property is not set. +- The binding's source and the of the element that has the are the same object and the property is not set. -- The property of the binding is equal to the of the and they are not explicitly set to `null`. +- The property of the binding is equal to the of the and they are not explicitly set to `null`. - In the example of the address, suppose that the of the is set to the object of type `Address`. The binding for each is added to the of the panel. + In the example of the address, suppose that the of the is set to the object of type `Address`. The binding for each is added to the of the panel. - You add objects to a . The is passed as the first parameter of the method when the runs. You can use the or method on that to get the proposed values of the object, and the property to get the sources of the bindings. + You add objects to a . The is passed as the first parameter of the method when the runs. You can use the or method on that to get the proposed values of the object, and the property to get the sources of the bindings. - A updates the sources of the binding at the same time instead of each binding being updated separately. When you call one of the methods to validate the data (, , or ), the binding for each in the example is validated and potentially updated. When a binding is part of a , the source of the binding is not updated until you call or on the , unless you explicitly set the property. + A updates the sources of the binding at the same time instead of each binding being updated separately. When you call one of the methods to validate the data (, , or ), the binding for each in the example is validated and potentially updated. When a binding is part of a , the source of the binding is not updated until you call or on the , unless you explicitly set the property. @@ -50,20 +50,20 @@ - Creates a and adds it the root when it creates the user interface (UI) of the application. -- Calls , , and in the application's logic to enable rolling back changes. +- Calls , , and in the application's logic to enable rolling back changes. -- Calls in a method to get the user's input and then check that an item over 100 dollars is available for at least seven days. +- Calls in a method to get the user's input and then check that an item over 100 dollars is available for at least seven days. The following example creates the user interface (UI) of the application. The root has a that contains a that validates the item, as described previously. The binding objects on the `Price` property and the `OfferExpires` property become part of the and each binding has a to make sure that price and date, respectively, are valid values. The validation rules for the individual properties run before the on the . :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetwindowlayout"::: - The following example shows the event handlers for the application. When the user clicks the Submit button, the application calls to run each that is associated with the . If each succeeds, saves the values to the object and ends the edit transaction. If is successful, the application begins another edit transaction. When a fails, the event occurs because the application set to `true` on the (in the previous example). `ItemError` handles the event and displays information about the validation error to the user. The example also handles the event for the and the event for the **Cancel** button. + The following example shows the event handlers for the application. When the user clicks the Submit button, the application calls to run each that is associated with the . If each succeeds, saves the values to the object and ends the edit transaction. If is successful, the application begins another edit transaction. When a fails, the event occurs because the application set to `true` on the (in the previous example). `ItemError` handles the event and displays information about the validation error to the user. The example also handles the event for the and the event for the **Cancel** button. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml.cs" id="Snippetwindowlogic"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window1.xaml.vb" id="Snippetwindowlogic"::: - The following example shows the custom `ValidateDateAndPrice`, which was added to the in the first example. The uses the in its method to get the values the user entered into the form, and checks that if an item is over 100 dollars, it will be available for at least seven days. + The following example shows the custom `ValidateDateAndPrice`, which was added to the in the first example. The uses the in its method to get the values the user entered into the form, and checks that if an item is over 100 dollars, it will be available for at least seven days. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Data.cs" id="Snippetvalidateobject"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/data.vb" id="Snippetvalidateobject"::: @@ -127,14 +127,14 @@ support discarding pending changes, you can call to begin the edit transaction, call to save the pending changes, call to discard the pending changes. + If the sources in the support discarding pending changes, you can call to begin the edit transaction, call to save the pending changes, call to discard the pending changes. - For each object in that implements , calls + For each object in that implements , calls ## Examples - The following example calls when a window loads to begin the edit transaction. + The following example calls when a window loads to begin the edit transaction. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml.cs" id="Snippetbeginedit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window1.xaml.vb" id="Snippetbeginedit"::: @@ -181,11 +181,11 @@ ## Remarks A belongs to a if one of the following cases occurs: -- The binding's source and the of the element that has the are the same object and the is not set. +- The binding's source and the of the element that has the are the same object and the is not set. -- The property of the binding and the of the are set to the same non-null value and the belongs to a parent element of the binding's target element. +- The property of the binding and the of the are set to the same non-null value and the belongs to a parent element of the binding's target element. -- You add a to . +- You add a to . ]]> @@ -223,12 +223,12 @@ ## Remarks This method causes the sources to discard the pending changes, if a source object is capable of doing so and end the edit transaction. Then the method updates the target properties with the saved source values. - For each object in that implements , calls + For each object in that implements , calls ## Examples - The following example calls to discard the pending changes and then calls to prepare the source to be re-edited. + The following example calls to discard the pending changes and then calls to prepare the source to be re-edited. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml.cs" id="Snippetcanceledit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window1.xaml.vb" id="Snippetcanceledit"::: @@ -308,12 +308,12 @@ ## Remarks If every succeeds, this method causes the sources to commit the pending changes and end the edit transaction, if a source object is capable of doing so. - For each object in that implements , calls + For each object in that implements , calls ## Examples - The following example calls to save the pending changes and then calls to prepare the source to be re-edited. + The following example calls to save the pending changes and then calls to prepare the source to be re-edited. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml.cs" id="Snippetbeginedit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window1.xaml.vb" id="Snippetbeginedit"::: @@ -358,12 +358,12 @@ method to get the value to be committed to the source. The type of the return value depends on the stage at which the occurs. For example, if a is data bound to a property of type integer and the that calls has its set to , the method returns a string. If the has its set to , the method returns whatever type that is returned by the binding's converter. In this example, usually returns an integer. + Use this method in the method to get the value to be committed to the source. The type of the return value depends on the stage at which the occurs. For example, if a is data bound to a property of type integer and the that calls has its set to , the method returns a string. If the has its set to , the method returns whatever type that is returned by the binding's converter. In this example, usually returns an integer. ## Examples - The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer. The application checks that the sales representative and the customer belong to the same region. The example shows the method, which uses the method to get values that the customer entered. + The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer. The application checks that the sales representative and the customer belong to the same region. The example shows the method, which uses the method to get values that the customer entered. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml.cs" id="Snippetitembindgroupvalidationrule"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window2.xaml.vb" id="Snippetitembindgroupvalidationrule"::: @@ -462,19 +462,19 @@ property once, even if the object is used as the source for multiple bindings. Often, there is just one item in , which is the object that is the of the element that uses the . It is possible for a to have multiple sources, however. For example, if Binding objects share the same but use different source objects, each object that is used as a source is in . + Each object that is used as a source is added into the property once, even if the object is used as the source for multiple bindings. Often, there is just one item in , which is the object that is the of the element that uses the . It is possible for a to have multiple sources, however. For example, if Binding objects share the same but use different source objects, each object that is used as a source is in . - There can also be multiple objects in if the path of a Binding resolves to a nested property of the source. For example, suppose a control's binding is a part of a and its is a `Customer` object, which has a property of type `Address`. If the of the is the `Address.ZipCode` property, the `Address` is added to the property. + There can also be multiple objects in if the path of a Binding resolves to a nested property of the source. For example, suppose a control's binding is a part of a and its is a `Customer` object, which has a property of type `Address`. If the of the is the `Address.ZipCode` property, the `Address` is added to the property. ## Examples - The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which are data bound to a different source. The binding of the first gets its source, `object1`, from the of the control's parent element (the ). On the second , the source of the binding is set to `object2`. The example also creates a that displays validation errors. + The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which are data bound to a different source. The binding of the first gets its source, `object1`, from the of the control's parent element (the ). On the second , the source of the binding is set to `object2`. The example also creates a that displays validation errors. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetbindinggroupname"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetvalidationadornersite"::: - The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. + The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml.cs" id="Snippetbindinggroupnamevalidationrule"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window3.xaml.vb" id="Snippetbindinggroupnamevalidationrule"::: @@ -523,21 +523,21 @@ is `null`, bindings that have a source that is the same object as the of the element that has the participate in the . + If is `null`, bindings that have a source that is the same object as the of the element that has the participate in the . - You can include bindings that have a source that is different from the of the parent element that has the by setting of the and the property of a binding to the same value. You can exclude bindings that have the same source as of the parent element that has the by setting of the and the property of a binding to different values. + You can include bindings that have a source that is different from the of the parent element that has the by setting of the and the property of a binding to the same value. You can exclude bindings that have the same source as of the parent element that has the by setting of the and the property of a binding to different values. ## Examples - The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which are data bound to a different source. The binding of the first is part of the because the inherits the and from its parent . + The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two controls, each of which are data bound to a different source. The binding of the first is part of the because the inherits the and from its parent . - The binding on the second is part of the because the of the and the of the are both set to `bindingGroup`. + The binding on the second is part of the because the of the and the of the are both set to `bindingGroup`. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetbindinggroupname"::: :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetvalidationadornersite"::: - The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. + The following example shows the that the previous example uses. In the method, the example gets each source object from the and checks whether the properties of the objects are equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml.cs" id="Snippetbindinggroupnamevalidationrule"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window3.xaml.vb" id="Snippetbindinggroupnamevalidationrule"::: @@ -592,7 +592,7 @@ ## Examples - The following example creates a and sets to `true` so that the application can handle the event when a fails. + The following example creates a and sets to `true` so that the application can handle the event when a fails. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetbindinggroup"::: @@ -671,7 +671,7 @@ ## Remarks A proposed value is a value that has been changed on the target of a binding, but has not been committed to the source. For example, suppose that there is a two-way binding on a and the property is set to . If the user changes the value of the , the proposed value is the value that is in the before it is committed to source. - When is `true`, the uses the proposed value when one binding leaves the BindingGroup and another Binding with the same source joins the BindingGroup. For example, suppose that an application enables a user to edit multiple fields and update the source object by clicking a button. When a field is not being edited, the application displays it in a . When the user begins to edit a field, the application replaces the with a . When the user finishes editing that field, the application replaces the with a . Because the source is not updated until the user clicks the button, there must be a way for the to display the proposed value. By setting to `true`, the application will display the user's changes to a field even when the source has not been updated. + When is `true`, the uses the proposed value when one binding leaves the BindingGroup and another Binding with the same source joins the BindingGroup. For example, suppose that an application enables a user to edit multiple fields and update the source object by clicking a button. When a field is not being edited, the application displays it in a . When the user begins to edit a field, the application replaces the with a . When the user finishes editing that field, the application replaces the with a . Because the source is not updated until the user clicks the button, there must be a way for the to display the proposed value. By setting to `true`, the application will display the user's changes to a field even when the source has not been updated. ]]> @@ -716,14 +716,14 @@ returns `false` if there is not a binding for the specified item and property or if the value of the specified property is not available, due to a conversion error or because an earlier validation rule failed. + returns `false` if there is not a binding for the specified item and property or if the value of the specified property is not available, due to a conversion error or because an earlier validation rule failed. - Use this method in the method to get the value to be committed to the source. The type `value` depends on the stage at which the occurs. For example, if a is data bound to a property of type integer, `value` is a string if the that calls has its set to . If the has its set to , the type of `value` is whatever type that is returned by the binding's converter. In this example, `value` is usually an integer. + Use this method in the method to get the value to be committed to the source. The type `value` depends on the stage at which the occurs. For example, if a is data bound to a property of type integer, `value` is a string if the that calls has its set to . If the has its set to , the type of `value` is whatever type that is returned by the binding's converter. In this example, `value` is usually an integer. ## Examples - The following example creates a custom named `ValidateDateAndPrice`. In the method, the example uses the method and the property to get the values the user entered into the form. Then the example checks that if an item is over 100 dollars, it will be available for at least seven days. This example is part of a larger example on the class + The following example creates a custom named `ValidateDateAndPrice`. In the method, the example uses the method and the property to get the values the user entered into the form. Then the example checks that if an item is over 100 dollars, it will be available for at least seven days. This example is part of a larger example on the class :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Data.cs" id="Snippetvalidateobject"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/data.vb" id="Snippetvalidateobject"::: @@ -770,12 +770,12 @@ succeeds, but it does not cause the sources to commit the pending changes and end the edit transaction. That is, if the source object implements . Calling this method does not cause to be called. Use the method to have the sources commit the pending changes. + This method updates the source if every succeeds, but it does not cause the sources to commit the pending changes and end the edit transaction. That is, if the source object implements . Calling this method does not cause to be called. Use the method to have the sources commit the pending changes. ## Examples - The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer. The application checks that the sales representative and the customer belong to the same region. The example calls to validate the bindings and save the values to the source if all the validation rules succeed. + The following example is part of an application that prompts the user to enter multiple customers and assign a sales representative to each customer. The application checks that the sales representative and the customer belong to the same region. The example calls to validate the bindings and save the values to the source if all the validation rules succeed. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window2.xaml.cs" id="Snippetupdatesources"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window2.xaml.vb" id="Snippetupdatesources"::: @@ -814,7 +814,7 @@ is `true`, the binding checks for and reports errors that are raised by a data source that implements . + When is `true`, the binding checks for and reports errors that are raised by a data source that implements . ]]> @@ -928,7 +928,7 @@ is added to a , the is passed in as the first parameter of the method. You can get the proposed values of the object by using the or method. You can get the objects that are the sources of the bindings from the property. + When a is added to a , the is passed in as the first parameter of the method. You can get the proposed values of the object by using the or method. You can get the objects that are the sources of the bindings from the property. @@ -937,7 +937,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window1.xaml" id="Snippetbindinggroup"::: - The following example shows the `ValidateDateAndPrice` class. The method uses the to get the values the user entered into the form, and checks that if an item is over 100 dollars, it will be available for at least seven days. + The following example shows the `ValidateDateAndPrice` class. The method uses the to get the values the user entered into the form, and checks that if an item is over 100 dollars, it will be available for at least seven days. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Data.cs" id="Snippetvalidateobject"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/data.vb" id="Snippetvalidateobject"::: diff --git a/xml/System.Windows.Data/BindingListCollectionView.xml b/xml/System.Windows.Data/BindingListCollectionView.xml index 5fb88c86c38..8cf941611f4 100644 --- a/xml/System.Windows.Data/BindingListCollectionView.xml +++ b/xml/System.Windows.Data/BindingListCollectionView.xml @@ -119,7 +119,7 @@ begins an add transaction. You should call or to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. + Calling begins an add transaction. You should call or to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. ]]> @@ -201,7 +201,7 @@ is `true` if the edited item implements the interface. If is `false`, call to cause the view to exit the edit state and provide logic to revert the changes on the object that was edited. + is `true` if the edited item implements the interface. If is `false`, call to cause the view to exit the edit state and provide logic to revert the changes on the object that was edited. ]]> @@ -241,7 +241,7 @@ sets to `null` and causes the collection view to exit the edit state. If is `true`, also restores the original values of the edited object. + sets to `null` and causes the collection view to exit the edit state. If is `true`, also restores the original values of the edited object. ]]> @@ -408,7 +408,7 @@ . + Use this property to test whether the view supports custom filtering before assigning a filter string to . ]]> @@ -445,7 +445,7 @@ does not support callback-based filtering, use instead. + does not support callback-based filtering, use instead. ]]> @@ -616,7 +616,7 @@ is applied to the new item when is called. + Any filtering, sorting, or grouping that is applied to the is applied to the new item when is called. ]]> @@ -658,7 +658,7 @@ . + This method does not make any assumptions about whether the item belongs to the underlying collection. If you know that the item belongs to the underlying collection, it is more efficient to call . ]]> @@ -824,7 +824,7 @@ ## Remarks Use the property to test whether the view supports custom filtering before assigning a string to this property. - The syntax depends on the implementation. For an example of the supported filter expression syntax, see . + The syntax depends on the implementation. For an example of the supported filter expression syntax, see . Note that if you have multiple objects and the underlying source is a `DataTable` or a `DataView`, the view objects do not sort or filter independently. For example, if you have two objects associated with the same `DataTable` and you perform sorting on one of the views, the order of items in the other view can be affected. This is because objects use the underlying for sorting and filtering functionalities. @@ -960,7 +960,7 @@ or properties that are set on the view. + This method evaluates the index with any or properties that are set on the view. ]]> @@ -1120,9 +1120,9 @@ or properties that are set on the view. + This method evaluates the index with any or properties that are set on the view. - For more information, see . + For more information, see . ]]> @@ -1162,7 +1162,7 @@ method, and you end the add transaction by calling or . + You begin an add transaction by calling the method, and you end the add transaction by calling or . ]]> @@ -1204,7 +1204,7 @@ 1. All items belonging to a given group appear consecutively, and -2. If the collection is non-empty, the groups in appear before any other groups, and in the same order as in . +2. If the collection is non-empty, the groups in appear before any other groups, and in the same order as in . ]]> @@ -1244,7 +1244,7 @@ method, and you end the transaction by calling or . + You begin an edit transaction by calling the method, and you end the transaction by calling or . ]]> @@ -1682,7 +1682,7 @@ method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine if the added or removed item requires processing. + Unlike the method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine if the added or removed item requires processing. ]]> @@ -1785,7 +1785,7 @@ does nothing. + If `item` is not in the collection, does nothing. ]]> @@ -1828,7 +1828,7 @@ so that 7 items appear, the valid values of `index` are 0 through 6. + `index` is relative to the collection view, not the collection. For example, if the collection has 10 items and the view has a so that 7 items appear, the valid values of `index` are 0 through 6. ]]> diff --git a/xml/System.Windows.Data/BindingOperations.xml b/xml/System.Windows.Data/BindingOperations.xml index dcc930cf22e..4b10e897cfd 100644 --- a/xml/System.Windows.Data/BindingOperations.xml +++ b/xml/System.Windows.Data/BindingOperations.xml @@ -269,7 +269,7 @@ of an item container. An item container is the UI element that displays an item in an . When an is data bound to a collection, an item container is generated for each item. In some cases, item containers are removed from the visual tree. Two typical cases where an item container is removed are when an item is removed from the underlying collection and when virtualization is enabled on the . In these cases, the property of the item container will be set to the property You should check whether the is equal to the before accessing the in the event for item containers. For more information about item containers and virtualization, see the remarks in the class. + Use this property if you need to deal with the of an item container. An item container is the UI element that displays an item in an . When an is data bound to a collection, an item container is generated for each item. In some cases, item containers are removed from the visual tree. Two typical cases where an item container is removed are when an item is removed from the underlying collection and when virtualization is enabled on the . In these cases, the property of the item container will be set to the property You should check whether the is equal to the before accessing the in the event for item containers. For more information about item containers and virtualization, see the remarks in the class. ]]> @@ -291,7 +291,7 @@ A WPF application can display a collection of data using an ) participates in the same synchronization mechanism. You do this by calling the method. +While you must synchronize your application's access to the collection, you must also guarantee that access from WPF (specifically from ) participates in the same synchronization mechanism. You do this by calling the method. To use a collection on multiple threads, one of which is the UI thread that owns the , an application has the following responsibilities: @@ -299,7 +299,7 @@ To use a collection on multiple threads, one of which is the UI thread that owns 1. Synchronize all access from the application to the collection using that mechanism. -1. Call to inform WPF of the mechanism. +1. Call to inform WPF of the mechanism. - The call must occur on the UI thread. @@ -307,11 +307,11 @@ To use a collection on multiple threads, one of which is the UI thread that owns - Call the overload if using a simple lock mechanism; call the overload if using a more elaborate mechanism. -1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) +1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) -1. If you call , that call must also occur on the UI thread. +1. If you call , that call must also occur on the UI thread. -1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. +1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. 1. Avoid deadlock. This is already the application's responsibility once it chooses to use synchronization, but it must also take into account WPF's participation in the synchronization, as discussed in the following paragraph. @@ -384,11 +384,11 @@ To use a collection on multiple threads, one of which is the UI thread that owns - The call must occur before using the collection on a different thread or before attaching the collection to the , whichever is later. -1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) +1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) -1. If you call , that call must also occur on the UI thread. +1. If you call , that call must also occur on the UI thread. -1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. +1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. 1. Avoid deadlock. This is already the application's responsibility once it chooses to use synchronization, but it must also take into account WPF's participation in the synchronization. (See more, below.) @@ -463,11 +463,11 @@ To use a collection on multiple threads, one of which is the UI thread that owns - The call must occur before using the collection on a different thread or before attaching the collection to the , whichever is later. -1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) +1. Ensure that a change to the collection and the notification of that change (through ) are atomic; no access from other threads can intervene. (This is usually free. For instance, guarantees this, provided that all changes are protected by synchronization.) -1. If you call , that call must also occur on the UI thread. +1. If you call , that call must also occur on the UI thread. -1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. +1. If you want to use the same collection on multiple UI threads, you must call (and , if needed) separately on each UI thread. 1. Avoid deadlock. This is already the application's responsibility once it chooses to use synchronization, but it must also take into account WPF's participation in the synchronization. (See more, below.) @@ -574,7 +574,7 @@ The net effect is that you can change the collection on any thread, and those ch class is the common base class for the , , and classes. You can use the , , and methods if you know in advance the type of binding that is set on the property. + The class is the common base class for the , , and classes. You can use the , , and methods if you know in advance the type of binding that is set on the property. ]]> @@ -618,14 +618,14 @@ The net effect is that you can change the collection on any thread, and those ch object maintains the connection between the binding source and the binding target. You can obtain the object by calling this static method or by calling the method on a data-bound or object. + The object maintains the connection between the binding source and the binding target. You can obtain the object by calling this static method or by calling the method on a data-bound or object. ## Examples - The following example shows the implementation of a event handler that uses the method to obtain the and then calls the property to access the binding source object. + The following example shows the implementation of a event handler that uses the method to obtain the and then calls the property to access the binding source object. - The `SavingsText` is the binding target object and is the binding target property. + The `SavingsText` is the binding target object and is the binding target property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Data/BindingExpression/DataItem/Page1.xaml.cs" id="Snippetonrentraise"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingExpression/DataItem/DirectionalBinding.vb" id="Snippetonrentraise"::: @@ -674,7 +674,7 @@ The net effect is that you can change the collection on any thread, and those ch class is the common base class for the , , and classes. You can use the , , and methods if you know in advance type of binding that is set on the property. + The class is the common base class for the , , and classes. You can use the , , and methods if you know in advance type of binding that is set on the property. ]]> @@ -876,7 +876,7 @@ The net effect is that you can change the collection on any thread, and those ch returns all objects that are invalid or have not been updated. + If `root` is `null`, returns all objects that are invalid or have not been updated. ]]> @@ -915,7 +915,7 @@ The net effect is that you can change the collection on any thread, and those ch returns all objects that are invalid or have not been updated. + If `root` is `null`, returns all objects that are invalid or have not been updated. ]]> diff --git a/xml/System.Windows.Data/CollectionView.xml b/xml/System.Windows.Data/CollectionView.xml index e86c5e8d0ae..4159082b06c 100644 --- a/xml/System.Windows.Data/CollectionView.xml +++ b/xml/System.Windows.Data/CollectionView.xml @@ -50,7 +50,7 @@ Because a view does not change the underlying source collection, a source collection can have multiple views associated with it. By using views, you can display the same data in different ways. For example, you can use two views on a collection of `Task` objects to show tasks sorted by priority on one part of the page and grouped by area on another part of the page. - In WPF applications, all collections have an associated default collection view. Rather than working with the collection directly, the binding engine always accesses the collection through the associated view. To get the default view, use the method. An internal class based on is the default view for collections that implement only . is the default view for collections that implement . is the default view for collections that implement or . + In WPF applications, all collections have an associated default collection view. Rather than working with the collection directly, the binding engine always accesses the collection through the associated view. To get the default view, use the method. An internal class based on is the default view for collections that implement only . is the default view for collections that implement . is the default view for collections that implement or . Alternatively, you can create a view of your collection in Extensible Application Markup Language (XAML) by using the class and then bind your control to that view. The class is the XAML representation of the class. For an example, see [How to: Sort and Group Data Using a View in XAML](/dotnet/framework/wpf/data/how-to-sort-and-group-data-using-a-view-in-xaml). @@ -207,7 +207,7 @@ . Derived classes override this property to indicate whether they support grouping. + Use this property to test whether the view supports sorting before adding . Derived classes override this property to indicate whether they support grouping. ]]> @@ -247,7 +247,7 @@ . Derived classes override this property to indicate whether they support sorting. + Use this property to test whether the view supports sorting before adding . Derived classes override this property to indicate whether they support sorting. ]]> @@ -417,7 +417,7 @@ method. + This method does not make any assumptions about whether the item belongs to the underlying collection. If the caller knows that the item belongs to the underlying collection, it is more efficient to call the method. ]]> @@ -613,7 +613,7 @@ Note that moving the current record pointer has some interactions with any sorting or filtering that is applied to the collection. Sorting preserves the current record pointer on the last record selected, but the collection view is restructured around it. (Perhaps the selected record was at the beginning of the list before, but now the selected record might be somewhere in the middle.) Filtering preserves the selected record if that selection remains in view after the filtering. Otherwise, the current record pointer is set to the first record of the filtered collection view. - The current item of the collection is bound to automatically if the target of a binding is a singleton value. If the target is an , the current item is synchronized with the selected item. For example, if a list box is bound to a collection, the is synchronized with the currently selected item. + The current item of the collection is bound to automatically if the target of a binding is a singleton value. If the target is an , the current item is synchronized with the selected item. For example, if a list box is bound to a collection, the is synchronized with the currently selected item. ]]> @@ -843,7 +843,7 @@ or property values that are set on the view. + This method evaluates the index with any or property values that are set on the view. If the underlying collection is of type , this is an O(N) operation. @@ -971,9 +971,9 @@ method of the view, if one exists. + If this method returns an index other than -1, it must always be true that view[index-1] < item <= view[index], where the comparisons are done using the method of the view, if one exists. - This particular behavior of the method is used by some event handlers to speed up reaction to insertion and deletion. If the derived class does not override this method, a listener does a binary search using the method. + This particular behavior of the method is used by some event handlers to speed up reaction to insertion and deletion. If the derived class does not override this method, a listener does a binary search using the method. ]]> @@ -1260,11 +1260,11 @@ is positioned before the beginning of the collection in the view. + If the specified item is not found, the method returns `false` and the is positioned before the beginning of the collection in the view. Collection views support the concept of a current record pointer. As you navigate through the objects in a collection view, you are moving a record pointer that allows you to retrieve the object that exists at that particular location in the collection. For more information, see "Binding to Collections" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - For more information about the current item of a view, see . + For more information about the current item of a view, see . @@ -1528,7 +1528,7 @@ method call. The typical scenario is if a or similar has been added to the view while the view is in a deferred refresh cycle (see ). In this scenario, no explicit call to is needed; as soon as the deferred refresh cycle ends, the view calls refresh automatically. + This property indicates if the internal state of the view has changed and requires a method call. The typical scenario is if a or similar has been added to the view while the view is in a deferred refresh cycle (see ). In this scenario, no explicit call to is needed; as soon as the deferred refresh cycle ends, the view calls refresh automatically. ]]> @@ -1572,9 +1572,9 @@ that implements has set to or , the is added to the collection. The always appears in the collection; it does not participate in grouping, sorting, or filtering. + When a that implements has set to or , the is added to the collection. The always appears in the collection; it does not participate in grouping, sorting, or filtering. - The cannot be the . Methods that perform relative navigation, such as the , skip the . and skip the if is set to or , respectively. Methods that perform absolute navigation, such as , do nothing if the would be the . + The cannot be the . Methods that perform relative navigation, such as the , skip the . and skip the if is set to or , respectively. Methods that perform absolute navigation, such as , do nothing if the would be the . ]]> @@ -1762,7 +1762,7 @@ if it is on the correct UI thread dispatcher and has never been updated from a different thread, or posts the change to the dispatcher to process it on the correct thread. + This method calls if it is on the correct UI thread dispatcher and has never been updated from a different thread, or posts the change to the dispatcher to process it on the correct thread. ]]> @@ -1836,7 +1836,7 @@ to -1. This method is called by collection changes that affect the . + This method sets to -1. This method is called by collection changes that affect the . ]]> @@ -1941,7 +1941,7 @@ method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine if the added or removed item requires processing. + Unlike the method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine if the added or removed item requires processing. ]]> @@ -2076,9 +2076,9 @@ , , or property; a refresh occurs. You do not have to call the method immediately after you set one of those properties. For information about how to delay automatic refresh, see . + When you set the , , or property; a refresh occurs. You do not have to call the method immediately after you set one of those properties. For information about how to delay automatic refresh, see . - Derived classes use the protected method to override the behavior of this method. + Derived classes use the protected method to override the behavior of this method. ]]> @@ -2229,7 +2229,7 @@ ## Remarks Call this overload from constructor of a derived class. Do not pass the property, which is a virtual property, as `count`. Instead, pass the count of the internal that represents the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Data/CollectionViewGroup.xml b/xml/System.Windows.Data/CollectionViewGroup.xml index a8d956123f1..c4f91057512 100644 --- a/xml/System.Windows.Data/CollectionViewGroup.xml +++ b/xml/System.Windows.Data/CollectionViewGroup.xml @@ -31,7 +31,7 @@ , your view object (a object or an object that derives from ) wraps each group in a object. + When you define groups using the , your view object (a object or an object that derives from ) wraps each group in a object. ## XAML Text Usage diff --git a/xml/System.Windows.Data/CollectionViewSource.xml b/xml/System.Windows.Data/CollectionViewSource.xml index eef29d9a4b9..256b2405066 100644 --- a/xml/System.Windows.Data/CollectionViewSource.xml +++ b/xml/System.Windows.Data/CollectionViewSource.xml @@ -425,7 +425,7 @@ collection. + This property is forwarded to any collection view created from this collection. ## XAML Attribute Usage @@ -437,7 +437,7 @@ ## XAML Values *ietfLanguageTag* - A string used to set the . This string is used to internally call. . For details on the string format, see . + A string used to set the . This string is used to internally call. . For details on the string format, see . ]]> @@ -606,7 +606,7 @@ . + This property is forwarded to any collection view created from the current . ## XAML Property Element Usage @@ -663,7 +663,7 @@ . For all collections implementing , the object is the default view object. The is the collection view class used for collections that implement and . To get the default view, you use the method. + All collections have a default . For all collections implementing , the object is the default view object. The is the collection view class used for collections that implement and . To get the default view, you use the method. ]]> diff --git a/xml/System.Windows.Data/CompositeCollection.xml b/xml/System.Windows.Data/CompositeCollection.xml index 19a5df1a711..b456d91d40b 100644 --- a/xml/System.Windows.Data/CompositeCollection.xml +++ b/xml/System.Windows.Data/CompositeCollection.xml @@ -50,11 +50,11 @@ Enables multiple collections and items to be displayed as a single list. - can contain items such as strings, objects, XML nodes, elements, as well as other collections. An uses the data in the to generate its content according to its . For more information about using objects to bind to collections, see the Binding to Collections section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - + can contain items such as strings, objects, XML nodes, elements, as well as other collections. An uses the data in the to generate its content according to its . For more information about using objects to bind to collections, see the Binding to Collections section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + ]]> @@ -189,11 +189,11 @@ Clears the collection. - @@ -334,11 +334,11 @@ Gets the number of items stored in this collection. The number of items stored in this collection. - object counts as 1 item. - + object counts as 1 item. + ]]> diff --git a/xml/System.Windows.Data/DataSourceProvider.xml b/xml/System.Windows.Data/DataSourceProvider.xml index 672f15201be..e952c91dd86 100644 --- a/xml/System.Windows.Data/DataSourceProvider.xml +++ b/xml/System.Windows.Data/DataSourceProvider.xml @@ -126,7 +126,7 @@ to have the public properties updated. + **Notes to Implementers:** You can choose to execute the query on the same thread or on a background thread or using `IsAsynchronous`. When the query is complete, call to have the public properties updated. ]]> @@ -389,11 +389,11 @@ to `false` to prevent or delay the automatic loading of data. + This method is typically called by the binding engine when dependent data bindings are activated. Set to `false` to prevent or delay the automatic loading of data. - The method can be called multiple times. The provider ignores subsequent calls once it is busy executing the initial query; the provider does not restart an already running query when is called again. When the query finishes successfully, any call still does not re-query data. The operation is typically asynchronous, a event is raised when the property assumed a new value. + The method can be called multiple times. The provider ignores subsequent calls once it is busy executing the initial query; the provider does not restart an already running query when is called again. When the query finishes successfully, any call still does not re-query data. The operation is typically asynchronous, a event is raised when the property assumed a new value. - The application calls to cause a refresh of the data. + The application calls to cause a refresh of the data. ]]> @@ -440,7 +440,7 @@ runs its query and sets its property the first time it is used by a binding or a . You can omit this step by setting the property to `false`. In this case, the application must explicitly call to cause the provider to obtain its data. + Typically the runs its query and sets its property the first time it is used by a binding or a . You can omit this step by setting the property to `false`. In this case, the application must explicitly call to cause the provider to obtain its data. ]]> @@ -477,7 +477,7 @@ when this property is `true`. + **Notes to implementers:** To get the best use out of refresh deferral, do not call when this property is `true`. ]]> @@ -677,7 +677,7 @@ event is raised when the property assumed a new value. If the refresh operation fails, the property is set to `null`; the property is set with the error exception. The application can call while a previous refresh is still underway. Calling twice raises the event twice. + A refresh operation is typically asynchronous, a event is raised when the property assumed a new value. If the refresh operation fails, the property is set to `null`; the property is set with the error exception. The application can call while a previous refresh is still underway. Calling twice raises the event twice. ]]> diff --git a/xml/System.Windows.Data/DataTransferEventArgs.xml b/xml/System.Windows.Data/DataTransferEventArgs.xml index f95cb38c082..6966e58c31b 100644 --- a/xml/System.Windows.Data/DataTransferEventArgs.xml +++ b/xml/System.Windows.Data/DataTransferEventArgs.xml @@ -24,13 +24,13 @@ Encapsulates arguments for data transfer events. - event occurs when a value is transferred from the binding source to the binding target, but only for bindings with the value set to `true`. - - The event occurs when a value is transferred from the target to the source, but only for bindings with the value set to `true`. - + event occurs when a value is transferred from the binding source to the binding target, but only for bindings with the value set to `true`. + + The event occurs when a value is transferred from the target to the source, but only for bindings with the value set to `true`. + ]]> diff --git a/xml/System.Windows.Data/IMultiValueConverter.xml b/xml/System.Windows.Data/IMultiValueConverter.xml index a48b90804da..d7576fcfe19 100644 --- a/xml/System.Windows.Data/IMultiValueConverter.xml +++ b/xml/System.Windows.Data/IMultiValueConverter.xml @@ -22,13 +22,13 @@ Provides a way to apply custom logic in a . - , create a class that implements the interface, and then implement the and methods. - - Individual bindings in the collection can have their own value converters. For more information, see . - + , create a class that implements the interface, and then implement the and methods. + + Individual bindings in the collection can have their own value converters. For more information, see . + ]]> @@ -68,19 +68,19 @@ The converter parameter to use. The culture to use in the converter. Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - A converted value. - - If the method returns , the valid value is used. - - A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value. - + A converted value. + + If the method returns , the valid value is used. + + A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value. + A return value of . indicates that the binding does not transfer the value or use the or the default value. - method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning .. - + method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning .. + ]]> @@ -123,19 +123,19 @@ Converts a binding target value to the source binding values. An array of values that have been converted from the target value back to the source values. - , the excess return values are ignored. If there are more source bindings than there are return values, the remaining source bindings do not have any values set on them. Types of return values are not verified against `targetTypes`; the values are set on the source bindings directly. - - Return at position `i` to indicate that no value is to be set on the source binding at index `i`. - - Return . at position `i` to indicate that the converter is unable to provide a value for the source binding at index `i`, and that no value is to be set on it. - - Return `null` to indicate that the converter cannot perform the conversion or that it does not support conversion in this direction. - - The data binding engine does not catch exceptions that are thrown by a user-supplied converter. Any exception that is thrown by the method or any uncaught exceptions that are thrown by methods that the method calls are treated as run-time errors. Handle anticipated problems by returning `null`. - + , the excess return values are ignored. If there are more source bindings than there are return values, the remaining source bindings do not have any values set on them. Types of return values are not verified against `targetTypes`; the values are set on the source bindings directly. + + Return at position `i` to indicate that no value is to be set on the source binding at index `i`. + + Return . at position `i` to indicate that the converter is unable to provide a value for the source binding at index `i`, and that no value is to be set on it. + + Return `null` to indicate that the converter cannot perform the conversion or that it does not support conversion in this direction. + + The data binding engine does not catch exceptions that are thrown by a user-supplied converter. Any exception that is thrown by the method or any uncaught exceptions that are thrown by methods that the method calls are treated as run-time errors. Handle anticipated problems by returning `null`. + ]]> diff --git a/xml/System.Windows.Data/IValueConverter.xml b/xml/System.Windows.Data/IValueConverter.xml index f3614eda40b..b78e081caa3 100644 --- a/xml/System.Windows.Data/IValueConverter.xml +++ b/xml/System.Windows.Data/IValueConverter.xml @@ -22,15 +22,15 @@ Provides a way to apply custom logic to a binding. - interface and then implement the and methods. Converters can change data from one type to another, translate data based on cultural information, or modify other aspects of the presentation. For examples of some typical converter scenarios, see "Data Conversion" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - - Value converters are culture-aware. Both the and methods have a `culture` parameter that indicates the cultural information. If cultural information is irrelevant to the conversion, then you can ignore that parameter in your custom converter. - - The and methods also have a parameter called `parameter` so that you can use the same instance of the converter with different parameters. For example, you can write a formatting converter that produces different formats of data based on the input parameter that you use. You can use the of the class to pass a parameter as an argument into the and methods. - + interface and then implement the and methods. Converters can change data from one type to another, translate data based on cultural information, or modify other aspects of the presentation. For examples of some typical converter scenarios, see "Data Conversion" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + + Value converters are culture-aware. Both the and methods have a `culture` parameter that indicates the cultural information. If cultural information is irrelevant to the conversion, then you can ignore that parameter in your custom converter. + + The and methods also have a parameter called `parameter` so that you can use the same instance of the converter with different parameters. For example, you can write a formatting converter that produces different formats of data based on the input parameter that you use. You can use the of the class to pass a parameter as an argument into the and methods. + ]]> @@ -74,17 +74,17 @@ Converts a value. A converted value. If the method returns , the valid null value is used. - method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning . - - A return value of indicates that the converter produced no value and that the binding uses the , if available, or the default value instead. - - A return value of indicates that the binding does not transfer the value or use the or default value. - + method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning . + + A return value of indicates that the converter produced no value and that the binding uses the , if available, or the default value instead. + + A return value of indicates that the binding does not transfer the value or use the or default value. + ]]> @@ -126,19 +126,19 @@ Converts a value. A converted value. If the method returns , the valid null value is used. - method. - - The data binding engine does not catch exceptions that are thrown by a user-supplied converter. Any exception that is thrown by the method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning .. - - A return value of indicates that the converter produced no value and that the binding uses the , if available, or the default value instead. - - A return value of indicates that the binding does not transfer the value or use the or default value. - + method. + + The data binding engine does not catch exceptions that are thrown by a user-supplied converter. Any exception that is thrown by the method, or any uncaught exceptions that are thrown by methods that the method calls, are treated as run-time errors. Handle anticipated problems by returning .. + + A return value of indicates that the converter produced no value and that the binding uses the , if available, or the default value instead. + + A return value of indicates that the binding does not transfer the value or use the or default value. + ]]> diff --git a/xml/System.Windows.Data/ListCollectionView.xml b/xml/System.Windows.Data/ListCollectionView.xml index c7aac9c629a..330e2e7462d 100644 --- a/xml/System.Windows.Data/ListCollectionView.xml +++ b/xml/System.Windows.Data/ListCollectionView.xml @@ -56,7 +56,7 @@ ## Remarks When you bind to a data collection, you may want to sort, filter, or group the data. To do that, you use collection views. You can think of a as the layer on top of the binding source collection that allows you to navigate and display the source collection based on sort, filter, and group queries, all without having to manipulate the underlying source collection itself. If the source collection implements the interface, the changes raised by the event are propagated to the views. - All collections have a default . For all collections implementing , the object is the default view object. The is the collection view class used for collections that implement . To get the default view, you use the method. For an example, see [How to: Get the Default View of a Data Collection](/dotnet/framework/wpf/data/how-to-get-the-default-view-of-a-data-collection). + All collections have a default . For all collections implementing , the object is the default view object. The is the collection view class used for collections that implement . To get the default view, you use the method. For an example, see [How to: Get the Default View of a Data Collection](/dotnet/framework/wpf/data/how-to-get-the-default-view-of-a-data-collection). For more information about collection views, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). @@ -205,7 +205,7 @@ starts an add transaction. You should call or to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. + Calling starts an add transaction. You should call or to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. ]]> @@ -248,7 +248,7 @@ method starts an add transaction. You should call the or methods to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. + Calling the method starts an add transaction. You should call the or methods to end the add transaction. A new item always appears in the collection view. Any filtering, sorting, or grouping that is applied to the view is applied to the new item when is called. ]]> @@ -330,7 +330,7 @@ property is `true`, you can specify an object to add to the collection by calling the method. is `false` if items cannot be added to the collection. + If the property is `true`, you can specify an object to add to the collection by calling the method. is `false` if items cannot be added to the collection. ]]> @@ -371,7 +371,7 @@ is `true` if the edited item implements the interface. If is `false`, call to cause the view to exit the edit state and provide logic to revert the changes on the object that was edited. + is `true` if the edited item implements the interface. If is `false`, call to cause the view to exit the edit state and provide logic to revert the changes on the object that was edited. ]]> @@ -411,7 +411,7 @@ sets to `null` and causes the collection view to exit the edit state. If is `true`, also restores the original values of the edited object. + sets to `null` and causes the collection view to exit the edit state. If is `true`, also restores the original values of the edited object. ]]> @@ -647,7 +647,7 @@ is `true` if the collection is not a fixed size and if an add or edit transaction is not occurring. + is `true` if the collection is not a fixed size and if an add or edit transaction is not occurring. ]]> @@ -749,7 +749,7 @@ is applied to the new item when is called. + Any filtering, sorting, or grouping that is applied to the is applied to the new item when is called. ]]> @@ -826,7 +826,7 @@ . + This method does not make any assumptions about whether the item belongs to the underlying collection. If you know that the item belongs to the underlying collection, it is more efficient to call . ]]> @@ -990,9 +990,9 @@ is in effect. + Setting this property causes an immediate refresh unless a is in effect. - Setting this property clears a previously set value. + Setting this property clears a previously set value. ]]> @@ -1135,7 +1135,7 @@ , , , and properties that are set on the view. + This method evaluates the index with any , , , and properties that are set on the view. ]]> @@ -1522,7 +1522,7 @@ method, and you end the add transaction by calling or . + You begin an add transaction by calling the method, and you end the add transaction by calling or . ]]> @@ -1564,7 +1564,7 @@ 1. All items belonging to a given group appear consecutively, and -2. If the collection is non-empty, the groups in appear before any other groups, and in the same order as in . +2. If the collection is non-empty, the groups in appear before any other groups, and in the same order as in . ]]> @@ -1604,7 +1604,7 @@ method, and you end the transaction by calling or . + You begin an edit transaction by calling the method, and you end the transaction by calling or . ]]> @@ -2086,7 +2086,7 @@ method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine whether the added or removed item requires processing. + Unlike the method, this method assumes that the specified item belongs to the underlying collection. This method takes filters into account. Typically, you use this method during collection-changed notifications to determine whether the added or removed item requires processing. ]]> @@ -2191,7 +2191,7 @@ does nothing. + If `item` is not in the collection, does nothing. ]]> @@ -2234,7 +2234,7 @@ so that 7 items appear, the valid values of `index` are 0 through 6. + `index` is relative to the collection view, not the collection. For example, if the collection has 10 items and the view has a so that 7 items appear, the valid values of `index` are 0 through 6. ]]> diff --git a/xml/System.Windows.Data/MultiBinding.xml b/xml/System.Windows.Data/MultiBinding.xml index fd3357de1d4..5b31dac6d04 100644 --- a/xml/System.Windows.Data/MultiBinding.xml +++ b/xml/System.Windows.Data/MultiBinding.xml @@ -39,7 +39,7 @@ ## Remarks You can specify multiple bindings in a object. When you use the object with a converter, it produces a final value for the binding target based on the values of those bindings. For example, color might be computed from red, blue, and green values, which can be values from the same or different binding source objects. When a value moves from the target to the sources, the target property value is translated to a set of values that are fed back into the bindings. - The values of the and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. + The values of the and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. currently supports only objects of type and not or . @@ -175,7 +175,7 @@ . For more information, see . + Individual bindings in the collection can have their own value . For more information, see . ## XAML Attribute Usage @@ -187,7 +187,7 @@ ## XAML Values *myConverter* - A resource reference to a class that implements the interface, which includes implementations of the and methods. To refer to a value converter, use the [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). + A resource reference to a class that implements the interface, which includes implementations of the and methods. To refer to a value converter, use the [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). ]]> @@ -248,7 +248,7 @@ ## XAML Values *ietfLanguageTag* - A string used to set the . This string is used to internally call. . For details on the string format, see . + A string used to set the . This string is used to internally call. . For details on the string format, see . ]]> @@ -316,7 +316,7 @@ ## XAML Values *converterParameter* - A value of the type expected by the converter, which might be an object element or a string depending on the definition and XAML capabilities both of the property type being used and of the implementation of the converter. The converter takes in that type through the `parameter` parameter as defined by its and implementations. + A value of the type expected by the converter, which might be an object element or a string depending on the definition and XAML capabilities both of the property type being used and of the implementation of the converter. The converter takes in that type through the `parameter` parameter as defined by its and implementations. ]]> @@ -361,7 +361,7 @@ and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. + The values of the and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. ]]> @@ -683,7 +683,7 @@ ## Remarks The class represents a built-in validation rule that checks for exceptions that are thrown during the update of the binding source properties. If you have associated the object with your object, you can use this property to set a handler to provide custom logic for handling these exceptions. - For an example, see . + For an example, see . For more information about the validation process for objects, see the property. @@ -729,7 +729,7 @@ and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. + The values of the and properties determine the functionality of the and are used as the default values for all the bindings in the collection unless an individual binding overrides these properties. For example, if the property on the object is set to , then all the bindings in the collection are considered unless you set a different value on one of the bindings explicitly. For more information, see the and properties. ]]> @@ -772,11 +772,11 @@ element explicitly. The is a built-in validation rule that checks for errors that are raised by the implementation of the source object. If an error is raised, the binding engine creates a with the error and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. + Setting this property provides an alternative to using the element explicitly. The is a built-in validation rule that checks for errors that are raised by the implementation of the source object. If an error is raised, the binding engine creates a with the error and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. For more information about the validation process for objects, see the property. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -820,11 +820,11 @@ element explicitly. The is a built-in validation rule that checks for exceptions that are thrown during the update of the source property. If an exception is thrown, the binding engine creates a with the exception and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. + Setting this property provides an alternative to using the element explicitly. The is a built-in validation rule that checks for exceptions that are thrown during the update of the source property. If an exception is thrown, the binding engine creates a with the exception and adds it to the collection of the bound element. The lack of an error clears this validation feedback, unless another rule raises a validation issue. For more information about the validation process for objects, see the property. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -867,7 +867,7 @@ is `true`, the binding checks for and reports errors that are raised by a data source that implements . + When is `true`, the binding checks for and reports errors that are raised by a data source that implements . ]]> @@ -903,7 +903,7 @@ object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object. After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. + You can set validation rules on both the object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object. After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. For more information about the validation process and how to provide visual feedback upon invalidation, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). diff --git a/xml/System.Windows.Data/MultiBindingExpression.xml b/xml/System.Windows.Data/MultiBindingExpression.xml index b4ed2ca51c5..90cd1fb67db 100644 --- a/xml/System.Windows.Data/MultiBindingExpression.xml +++ b/xml/System.Windows.Data/MultiBindingExpression.xml @@ -98,7 +98,7 @@ object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object (multi-value converter). After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. + You can set validation rules on both the object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object (multi-value converter). After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. ]]> @@ -259,7 +259,7 @@ object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object (multi-value converter). After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. + You can set validation rules on both the object and the individual objects in the object. The binding engine evaluates the on the object when a value moves from the binding target property to the object (multi-value converter). After that, when a value moves from the converter to the binding source property of an individual binding, the binding engine evaluates the on that object. ]]> diff --git a/xml/System.Windows.Data/ObjectDataProvider.xml b/xml/System.Windows.Data/ObjectDataProvider.xml index 993390eabdc..4f4d89bd305 100644 --- a/xml/System.Windows.Data/ObjectDataProvider.xml +++ b/xml/System.Windows.Data/ObjectDataProvider.xml @@ -113,7 +113,7 @@ and methods of the base class. + This method is called by the and methods of the base class. ]]> @@ -155,7 +155,7 @@ to refresh. When changing multiple refresh-causing properties, the use of is recommended. + Changing this collection implicitly causes the to refresh. When changing multiple refresh-causing properties, the use of is recommended. ## XAML Property Element Usage @@ -311,7 +311,7 @@ The highlighted lines in the following example use an property to call a method on your object and use the property to pass parameters to the method. You can then bind to the results of the method. - Changing this collection implicitly causes the object to refresh. When changing multiple refresh-causing properties, the use of is recommended. + Changing this collection implicitly causes the object to refresh. When changing multiple refresh-causing properties, the use of is recommended. ## XAML Property Element Usage @@ -358,9 +358,9 @@ The highlighted lines in the following example use an is set to a non-null value, the property holds the object of the type specified by . If is assigned by the user, the property returns the type of the assigned object. If is set to a , the uses the of the assigned source provider as the effective . + When is set to a non-null value, the property holds the object of the type specified by . If is assigned by the user, the property returns the type of the assigned object. If is set to a , the uses the of the assigned source provider as the effective . - If is used, and will not update until is called. + If is used, and will not update until is called. ]]> @@ -404,7 +404,7 @@ The highlighted lines in the following example use an is used, and do not update until is called. + If is used, and do not update until is called. ## XAML Attribute Usage diff --git a/xml/System.Windows.Data/PriorityBinding.xml b/xml/System.Windows.Data/PriorityBinding.xml index 40b6d5d1436..087bb3e6bee 100644 --- a/xml/System.Windows.Data/PriorityBinding.xml +++ b/xml/System.Windows.Data/PriorityBinding.xml @@ -51,7 +51,7 @@ The priority of the bindings is determined by their order in the list. The binding that appears first in the list has the highest priority. - The binding engine starts with the first binding in the list and verifies whether that binding returns a value successfully; if it does, the value from that binding is used. If the first binding does not return a value successfully, the binding engine examines the second binding to determine whether it returns a value successfully; if it does, the value from the second binding becomes the active value. This verification process continues to the end of the list of bindings. If none of the bindings returns a value successfully, the binding uses the . + The binding engine starts with the first binding in the list and verifies whether that binding returns a value successfully; if it does, the value from that binding is used. If the first binding does not return a value successfully, the binding engine examines the second binding to determine whether it returns a value successfully; if it does, the value from the second binding becomes the active value. This verification process continues to the end of the list of bindings. If none of the bindings returns a value successfully, the binding uses the . The binding engine continues to listen for changes on all bindings. If at any point one of the bindings that has a higher priority returns a value successfully, the value for that binding becomes the active value and replaces the current value. diff --git a/xml/System.Windows.Data/PriorityBindingExpression.xml b/xml/System.Windows.Data/PriorityBindingExpression.xml index 50498f71024..0c4388460ba 100644 --- a/xml/System.Windows.Data/PriorityBindingExpression.xml +++ b/xml/System.Windows.Data/PriorityBindingExpression.xml @@ -29,7 +29,7 @@ ## Remarks is a single run-time instance of a . Therefore, it describes a collection of objects that are attached to a single binding target property, which receives its value from the first object in the collection that returns a value successfully. For information about binding expressions, see the Binding and BindingExpression section in the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - The binding engine determines which of the objects is the based on priority. For more information, see . + The binding engine determines which of the objects is the based on priority. For more information, see . ]]> @@ -66,7 +66,7 @@ objects is the based on priority. For more information, see . + The binding engine determines which of the objects is the based on priority. For more information, see . ]]> @@ -188,7 +188,7 @@ method on the property. + This method calls the method on the property. ]]> @@ -223,7 +223,7 @@ method on the property. + This method calls the method on the property. ]]> diff --git a/xml/System.Windows.Data/PropertyGroupDescription.xml b/xml/System.Windows.Data/PropertyGroupDescription.xml index e4b325f6bca..f3197e7fc78 100644 --- a/xml/System.Windows.Data/PropertyGroupDescription.xml +++ b/xml/System.Windows.Data/PropertyGroupDescription.xml @@ -29,7 +29,7 @@ ## Remarks Views support the functionality of grouping, which allows the user to partition the collection in the collection view into logical groups. The groups can be explicit, where the user supplies a list of groups, or implicit, where the groups are generated dynamically depending on the data. - allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. + allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. You can also define how string comparison should take place using the property. @@ -203,7 +203,7 @@ can be used as a value for . + can be used as a value for . ]]> @@ -238,7 +238,7 @@ can be used as a value for . + can be used as a value for . ]]> @@ -403,7 +403,7 @@ allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. + allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. You can also define how string comparison should take place using the property. diff --git a/xml/System.Windows.Data/RelativeSource.xml b/xml/System.Windows.Data/RelativeSource.xml index d5f2a144ee0..effe638dfdb 100644 --- a/xml/System.Windows.Data/RelativeSource.xml +++ b/xml/System.Windows.Data/RelativeSource.xml @@ -37,7 +37,7 @@ property. This is the property type of that property. is simultaneously a markup extension implementation and a data object. When the extension returns itself (see ), the relevant information is contained in the data. The main purpose of the markup extension is to allow a variable-argument constructor syntax in attribute form, so that the mode can be defined inline with the two extra arguments for ancestor type and level that the other modes do not require. + One of the ways to specify a binding source is to use the property. This is the property type of that property. is simultaneously a markup extension implementation and a data object. When the extension returns itself (see ), the relevant information is contained in the data. The main purpose of the markup extension is to allow a variable-argument constructor syntax in attribute form, so that the mode can be defined inline with the two extra arguments for ancestor type and level that the other modes do not require. For XAML information, see [RelativeSource MarkupExtension](/dotnet/framework/wpf/advanced/relativesource-markupextension). @@ -207,7 +207,7 @@ ## Remarks -If the property is not set explicitly, setting the or the property will implicitly lock the property value to . +If the property is not set explicitly, setting the or the property will implicitly lock the property value to . ## XAML Text Usage @@ -263,7 +263,7 @@ For XAML information, see [RelativeSource MarkupExtension](/dotnet/framework/wpf ## Remarks -If the property is not set explicitly, setting the or the property will implicitly lock the property value to . +If the property is not set explicitly, setting the or the property will implicitly lock the property value to . ## XAML Text Usage @@ -325,7 +325,7 @@ For XAML information, see [RelativeSource MarkupExtension](/dotnet/framework/wpf or the and the properties will implicitly lock this property value to . + This property is read-only after initialization. If this property is not set explicitly, setting the or the and the properties will implicitly lock this property value to . ## XAML Text Usage diff --git a/xml/System.Windows.Data/UpdateSourceExceptionFilterCallback.xml b/xml/System.Windows.Data/UpdateSourceExceptionFilterCallback.xml index 4a3da83eb39..050371bfc72 100644 --- a/xml/System.Windows.Data/UpdateSourceExceptionFilterCallback.xml +++ b/xml/System.Windows.Data/UpdateSourceExceptionFilterCallback.xml @@ -56,7 +56,7 @@ ## Remarks If you have associated the with your object you have the option to use the property to set this callback to provide custom logic for handling the exceptions. This callback is invoked whenever any exception is encountered when the binding engine updates the binding source value. - If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. + If an is not specified on the , the binding engine creates a with the exception and adds it to the collection of the bound element. diff --git a/xml/System.Windows.Data/UpdateSourceTrigger.xml b/xml/System.Windows.Data/UpdateSourceTrigger.xml index eb5b92630fe..dcaa1d550a2 100644 --- a/xml/System.Windows.Data/UpdateSourceTrigger.xml +++ b/xml/System.Windows.Data/UpdateSourceTrigger.xml @@ -27,9 +27,9 @@ ## Remarks -A programmatic way to determine the default `UpdateSourceTrigger` value of a dependency property is to get the property metadata of the property using , and then to check the value of the property. +A programmatic way to determine the default `UpdateSourceTrigger` value of a dependency property is to get the property metadata of the property using , and then to check the value of the property. -For more information, see . +For more information, see . ]]> diff --git a/xml/System.Windows.Data/ValueUnavailableException.xml b/xml/System.Windows.Data/ValueUnavailableException.xml index ff9560d0bee..54e2a975d4d 100644 --- a/xml/System.Windows.Data/ValueUnavailableException.xml +++ b/xml/System.Windows.Data/ValueUnavailableException.xml @@ -80,8 +80,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The localized error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The localized error message string.| ]]> @@ -129,8 +129,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| ]]> @@ -217,8 +217,8 @@ |Property|Value| |--------------|-----------| -||The inner exception reference.| -||The error message string.| +||The inner exception reference.| +||The error message string.| ]]> diff --git a/xml/System.Windows.Data/XmlDataProvider.xml b/xml/System.Windows.Data/XmlDataProvider.xml index 46d127ce084..c23c2b1d97f 100644 --- a/xml/System.Windows.Data/XmlDataProvider.xml +++ b/xml/System.Windows.Data/XmlDataProvider.xml @@ -159,7 +159,7 @@ ## Remarks The execution is either immediate or on a background thread, based on the value of the property. - This method is called by the and methods of the base class. + This method is called by the and methods of the base class. ]]> @@ -217,7 +217,7 @@ If the property is set, then any inline XML data is discarded. If the property is set, then the property is cleared and any inline XML data is discarded. - Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. + Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. ]]> @@ -476,7 +476,7 @@ If the property is set, then any inline XML data is discarded. If the property is set, then the property is cleared and any inline XML data is discarded. - Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. + Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. @@ -485,7 +485,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Data/XmlDataProvider/Source/Window1.xaml" id="Snippetxmlfileexample"::: - If the XML data resides in a remote XML file, you define access to the data by assigning an appropriate URL to the attribute as follows: + If the XML data resides in a remote XML file, you define access to the data by assigning an appropriate URL to the attribute as follows: ```xaml @@ -577,7 +577,7 @@ object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. + Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. ## XAML Attribute Usage @@ -721,9 +721,9 @@ method handles the `XPath` expressions from the property. `XPath` functions are not supported. For `XPath` expression information, see the documentation and some examples provided in the Example section. + The method handles the `XPath` expressions from the property. `XPath` functions are not supported. For `XPath` expression information, see the documentation and some examples provided in the Example section. - Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. + Setting the following properties will implicitly cause this object to refresh: , , , and . When changing multiple refresh-causing properties, the use of is recommended. ]]> diff --git a/xml/System.Windows.Data/XmlNamespaceMapping.xml b/xml/System.Windows.Data/XmlNamespaceMapping.xml index 9cdb347b40d..47a7cc5babc 100644 --- a/xml/System.Windows.Data/XmlNamespaceMapping.xml +++ b/xml/System.Windows.Data/XmlNamespaceMapping.xml @@ -28,11 +28,11 @@ Declares a mapping between a uniform resource identifier (URI) and a prefix. - class and add it to an object that is used as the for a binding. - + class and add it to an object that is used as the for a binding. + ]]> @@ -253,7 +253,7 @@ if the two objects are not the same; otherwise, . - . ]]> + . ]]> diff --git a/xml/System.Windows.Data/XmlNamespaceMappingCollection.xml b/xml/System.Windows.Data/XmlNamespaceMappingCollection.xml index 3f8e19681dd..3ebd817e279 100644 --- a/xml/System.Windows.Data/XmlNamespaceMappingCollection.xml +++ b/xml/System.Windows.Data/XmlNamespaceMappingCollection.xml @@ -46,11 +46,11 @@ Represents a collection of objects. - class provides a mapping between the namespace specified in your XML binding source and a prefix you specify that you can use in Extensible Application Markup Language (XAML). - + class provides a mapping between the namespace specified in your XML binding source and a prefix you specify that you can use in Extensible Application Markup Language (XAML). + ]]> @@ -214,11 +214,11 @@ Removes all objects in this collection. - object. - + object. + ]]> @@ -444,11 +444,11 @@ Returns a generic object. A generic object. - implementations. - + implementations. + ]]> @@ -530,11 +530,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -578,11 +578,11 @@ The child to add. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -626,11 +626,11 @@ The text to add to the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Diagnostics/StaticResourceResolvedEventArgs.xml b/xml/System.Windows.Diagnostics/StaticResourceResolvedEventArgs.xml index 3335fe63b95..b94b30a503a 100644 --- a/xml/System.Windows.Diagnostics/StaticResourceResolvedEventArgs.xml +++ b/xml/System.Windows.Diagnostics/StaticResourceResolvedEventArgs.xml @@ -79,11 +79,11 @@ The key for the requested resource. The key for the requested resource. - method if the resource is created in code. - + method if the resource is created in code. + ]]> diff --git a/xml/System.Windows.Documents.DocumentStructures/ListItemStructure.xml b/xml/System.Windows.Documents.DocumentStructures/ListItemStructure.xml index d0ccbff2b05..bad87e50373 100644 --- a/xml/System.Windows.Documents.DocumentStructures/ListItemStructure.xml +++ b/xml/System.Windows.Documents.DocumentStructures/ListItemStructure.xml @@ -146,7 +146,7 @@ mirrors a set of items, usually short paragraphs, that are actually formatted as a list in the `` part of a document's markup. Typically, each item in the list is formatted with a marker such as a numeral, character, or bullet. The marker could also be multiple characters or even an image. The value of the property is the attribute of the element, in the `` part of a document's markup, that specifies what that marker is. For example, if the marker element specifies the numeral 3 as the marker for a list item and the of that element is 'ThirdItem', then the property of the that mirrors the list item should be set to 'ThirdItem.' + A mirrors a set of items, usually short paragraphs, that are actually formatted as a list in the `` part of a document's markup. Typically, each item in the list is formatted with a marker such as a numeral, character, or bullet. The marker could also be multiple characters or even an image. The value of the property is the attribute of the element, in the `` part of a document's markup, that specifies what that marker is. For example, if the marker element specifies the numeral 3 as the marker for a list item and the of that element is 'ThirdItem', then the property of the that mirrors the list item should be set to 'ThirdItem.' If a list item has a marker, failing to reference the marker with the property of the corresponding may force applications that are consuming the to display or print the marker at the end of the document. diff --git a/xml/System.Windows.Documents.DocumentStructures/NamedElement.xml b/xml/System.Windows.Documents.DocumentStructures/NamedElement.xml index ef92bf1565d..0d3ac9048c8 100644 --- a/xml/System.Windows.Documents.DocumentStructures/NamedElement.xml +++ b/xml/System.Windows.Documents.DocumentStructures/NamedElement.xml @@ -111,12 +111,12 @@ should be identical to the attribute of the element to which the refers. + should be identical to the attribute of the element to which the refers. ## Examples - The following example shows several elements, each with a attribute. + The following example shows several elements, each with a attribute. :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Content/FixedPage2_structure.xaml" id="Snippetdocstructparastruct2"::: diff --git a/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml b/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml index fb55690a4ee..ec0da66d65c 100644 --- a/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml +++ b/xml/System.Windows.Documents.DocumentStructures/StoryFragment.xml @@ -378,7 +378,7 @@ ## Remarks All fragments of a given story must have the same value for this property. It must match the `StoryName` attribute of the `` element. See section 9.1.15 of the XML Paper Specification (XPS) specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). - This property can be unspecified if is Header or Footer. + This property can be unspecified if is Header or Footer. diff --git a/xml/System.Windows.Documents.Serialization/SerializerDescriptor.xml b/xml/System.Windows.Documents.Serialization/SerializerDescriptor.xml index f73bf8c4323..78f7080aa12 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerDescriptor.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerDescriptor.xml @@ -24,20 +24,20 @@ Provides information about installed plug-in serializers. - interface. - - - -## Examples - The following examples illustrate using a to return information on installed plug-in serializers. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - + interface. + + + +## Examples + The following examples illustrate using a to return information on installed plug-in serializers. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + ]]> @@ -190,11 +190,11 @@ Creates a new through a given implementation. A new with its properties initialized with values from the given implementation. - @@ -235,15 +235,15 @@ Gets the default extension associated with files that the serializer outputs. The default extension associated with files that the serializer outputs. - to return the default file extensions for installed plug-in serializers. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - + to return the default file extensions for installed plug-in serializers. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + ]]> @@ -281,13 +281,13 @@ Gets the public display name of the serializer. The public display name of the serializer. - to obtain and display the public name of a plug-in serializer. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - + to obtain and display the public name of a plug-in serializer. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + ]]> @@ -324,11 +324,11 @@ if both are equal; otherwise, . - returns `true` even if the two objects differ in one or more of the following properties: , , and . - + returns `true` even if the two objects differ in one or more of the following properties: , , and . + ]]> @@ -396,11 +396,11 @@ Gets the unique hash code value of the serializer. The unique hash code value of the serializer. - , , , , , and properties of the serializer. - + , , , , , and properties of the serializer. + ]]> @@ -439,20 +439,20 @@ if the serializer assembly can be loaded; otherwise, . The default is . - should be `false` unless has the same value as . - - - -## Examples - The following examples illustrate using to determine if the associated plug-in serializer can be loaded and used. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + should be `false` unless has the same value as . + + + +## Examples + The following examples illustrate using to determine if the associated plug-in serializer can be loaded and used. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -490,11 +490,11 @@ Gets the name of the company that developed the serializer. The name of the company that developed the plug-in serializer. - interface. - + interface. + ]]> @@ -567,11 +567,11 @@ Gets the version of .NET required by the serializer. The version of .NET required by the plug-in serializer. - must have the same value as the or the serializer assembly cannot be loaded. - + must have the same value as the or the serializer assembly cannot be loaded. + ]]> diff --git a/xml/System.Windows.Documents.Serialization/SerializerProvider.xml b/xml/System.Windows.Documents.Serialization/SerializerProvider.xml index 24ff86c67d3..b103a0b6679 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerProvider.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerProvider.xml @@ -55,20 +55,20 @@ Initializes a new instance of the class. - . - - - -## Examples - The following examples show use of the constructor. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . + + + +## Examples + The following examples show use of the constructor. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -112,33 +112,33 @@ Initializes an object derived from the abstract class for the specified that will use the specified descriptor. An object of a class derived from . - . - - - -## Examples - The following example shows using to return a plug-in serialization writer for saving a file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . + + + +## Examples + The following example shows using to return a plug-in serialization writer for saving a file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> One of the parameters is null. - The is specifying the wrong version. - - -or- - - It is not registered. - - -or- - - The assembly file cannot be found. - - -or- - + The is specifying the wrong version. + + -or- + + It is not registered. + + -or- + + The assembly file cannot be found. + + -or- + The assembly cannot be loaded. @@ -175,15 +175,15 @@ Gets a collection of the installed plug-in serializers. A of the objects already registered. - to enumerate the plug-in serializers when saving a file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - + to enumerate the plug-in serializers when saving a file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + ]]> @@ -227,13 +227,13 @@ to overwrite an existing registration for the same plug-in; otherwise, . Registers a serializer plug-in. - , , , and . - + , , , and . + ]]> @@ -278,13 +278,13 @@ The for the plug-in. Deletes a serializer plug-in from the registry. - , , , and . - + , , , and . + ]]> diff --git a/xml/System.Windows.Documents.Serialization/SerializerWriter.xml b/xml/System.Windows.Documents.Serialization/SerializerWriter.xml index 61d2e265a1d..fb99cea9528 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerWriter.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerWriter.xml @@ -24,15 +24,15 @@ Defines the abstract methods and events that are required to implement a plug-in document output serializer. - . - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: - + . + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializefilefilter"::: + ]]> @@ -67,18 +67,18 @@ Initializes a new instance of the class. - should be created by using the method of a object, not the method of an object. - - - -## Examples - The following example shows how to create a using the . method. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + should be created by using the method of a object, not the method of an object. + + + +## Examples + The following example shows how to create a using the . method. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -121,14 +121,14 @@ When overridden in a derived class, returns a that writes collated elements to the serialization . - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -161,14 +161,14 @@ When overridden in a derived class, returns a that writes collated elements. A that writes collated elements to the document output serialization . - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -216,21 +216,21 @@ When overridden in a derived class, returns a that writes collated elements together with the given print tickets. A that writes collated elements to the document output serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - - -## Examples - The following example shows the use of the method. - + . If needed, use the method to create a -specific that is valid for a given printer. + + + +## Examples + The following example shows the use of the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -247,18 +247,18 @@ When overridden in a derived class, synchronously writes content to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -294,18 +294,18 @@ The document paginator that defines the content to write to the serialization . When overridden in a derived class, synchronously writes the content of a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -341,18 +341,18 @@ The document to write to the serialization . When overridden in a derived class, synchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -388,18 +388,18 @@ The document sequence that defines the content to write to the serialization . When overridden in a derived class, synchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -435,18 +435,18 @@ The page to write to the serialization . When overridden in a derived class, synchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -482,18 +482,18 @@ The element to write to the serialization . When overridden in a derived class, synchronously writes a given element to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -537,22 +537,22 @@ The default print preferences for the content. When overridden in a derived class, synchronously writes paginated content together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -596,22 +596,22 @@ The default print preferences for the content. When overridden in a derived class, synchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -655,22 +655,22 @@ The default print preferences for the content. When overridden in a derived class, synchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -714,22 +714,22 @@ The default print preferences for the content. When overridden in a derived class, synchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -773,22 +773,22 @@ The default print preferences for the element. When overridden in a derived class, synchronously writes a given element together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - - - -## Examples - The following example shows the use of the method to serialize a flow document to an output file. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + + + +## Examples + The following example shows the use of the method to serialize a flow document to an output file. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializeplugin"::: + ]]> @@ -802,11 +802,11 @@ When overridden in a derived class, asynchronously writes content to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -841,11 +841,11 @@ The document paginator that defines the content to write to the serialization . When overridden in a derived class, asynchronously writes the content of a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -887,11 +887,11 @@ The document to write to the serialization . When overridden in a derived class, asynchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -933,11 +933,11 @@ The document sequence that defines the content to write to the serialization . When overridden in a derived class, asynchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -979,11 +979,11 @@ The page to write to the serialization . When overridden in a derived class, asynchronously writes a given to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1025,11 +1025,11 @@ The element to write to the serialization . When overridden in a derived class, asynchronously writes a given element to the serialization . - of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1073,13 +1073,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes the content of a given to the serialization . - when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1127,15 +1127,15 @@ The default print preferences for the content. When overridden in a derived class, asynchronously writes the content of a given to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1179,13 +1179,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given to the serialization . - when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1233,15 +1233,15 @@ The default print preferences for the content. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1285,13 +1285,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given to the serialization . - when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1339,15 +1339,15 @@ The default print preferences for the content. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1391,13 +1391,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given to the serialization . - when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1445,15 +1445,15 @@ The default print preferences for the content. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1497,13 +1497,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given element to the serialization . - when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1551,13 +1551,13 @@ The default print preferences for the element. When overridden in a derived class, asynchronously writes a given element together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1609,17 +1609,17 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes paginated content together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - `userState` is passed to the when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + `userState` is passed to the when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1669,17 +1669,17 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - `userState` is passed to the when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + `userState` is passed to the when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1729,17 +1729,17 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - `userState` is passed to the when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + `userState` is passed to the when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1789,17 +1789,17 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given together with an associated to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - `userState` is passed to the when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + `userState` is passed to the when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1849,17 +1849,17 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given element together with an associated and identifier to the serialization . - . If needed, use the method to create a -specific that is valid for a given printer. - - `userState` is passed to the when the event occurs. - - The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . - + . If needed, use the method to create a -specific that is valid for a given printer. + + `userState` is passed to the when the event occurs. + + The output of the write operation is normally specified as a parameter to the constructor of the derived class that implements . + ]]> @@ -1960,11 +1960,11 @@ When overridden in a derived class, occurs just before a is added to a stream by a or method. - event enables the event handler to substitute a new for the one specified in the or method call. - + event enables the event handler to substitute a new for the one specified in the or method call. + ]]> @@ -1999,11 +1999,11 @@ When overridden in a derived class, occurs when the updates its progress. - could update its progress after every page or after every document in a multi-document write operation. - + could update its progress after every page or after every document in a multi-document write operation. + ]]> diff --git a/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml b/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml index 84e25f7178e..ebcbe59df7a 100644 --- a/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml +++ b/xml/System.Windows.Documents.Serialization/SerializerWriterCollator.xml @@ -25,8 +25,8 @@ Defines the abstract methods required to implement a plug-in document serialization collator. To be added. - A is created with the method of the class. - + A is created with the method of the class. + The writes to the same output stream as is written to by the that created the . @@ -61,8 +61,8 @@ Initializes a new instance of the class. To be added. - A is created with the method of the class. - + A is created with the method of the class. + The writes to the same output stream as is written to by the that created the . @@ -195,11 +195,11 @@ When overridden in a derived class, synchronously writes a given element to the serialization stream. - methods write to the stream associated with the that created the from the call to . - + methods write to the stream associated with the that created the from the call to . + ]]> @@ -236,11 +236,11 @@ The visual element to write to the serialization . When overridden in a derived class, synchronously writes a given element to the serialization stream. - method writes to the stream associated with the that created the from the call to . - + method writes to the stream associated with the that created the from the call to . + ]]> @@ -285,11 +285,11 @@ An object specifying preferences for how the material should be printed. When overridden in a derived class, synchronously writes a given element together with an associated print ticket to the serialization stream. - method writes to the stream associated with the that created the from the call to . - + method writes to the stream associated with the that created the from the call to . + ]]> @@ -304,11 +304,11 @@ When overridden in a derived class, asynchronously writes a given element to the serialization stream. - methods write to the stream associated with the that created the from the call to . - + methods write to the stream associated with the that created the from the call to . + ]]> @@ -345,11 +345,11 @@ The visual element to write to the serialization . When overridden in a derived class, asynchronously writes a given element to the serialization stream. - methods write to the stream associated with the that created the from the call to . - + methods write to the stream associated with the that created the from the call to . + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -390,13 +390,13 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given element with a specified event identifier to the serialization stream. - methods write to the stream associated with the that created the from the call to . - - `userState` is passed to the when the event occurs. - + methods write to the stream associated with the that created the from the call to . + + `userState` is passed to the when the event occurs. + ]]> @@ -441,13 +441,13 @@ The default print preferences for the element. When overridden in a derived class, asynchronously writes a given element together with an associated print ticket to the serialization stream. - method writes to the stream associated with the that created the from the call to . - - `printTicket` can be `null` if there are no preferred print settings. - + method writes to the stream associated with the that created the from the call to . + + `printTicket` can be `null` if there are no preferred print settings. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -496,15 +496,15 @@ A caller-specified object to identify the asynchronous write operation. When overridden in a derived class, asynchronously writes a given element together with an associated print ticket and identifier to the serialization stream. - method writes to the stream associated with the that created the from the call to . - - `printTicket` can be `null` if there are no preferred print settings. - - `userState` is passed to the when the event occurs. - + method writes to the stream associated with the that created the from the call to . + + `printTicket` can be `null` if there are no preferred print settings. + + `userState` is passed to the when the event occurs. + ]]> diff --git a/xml/System.Windows.Documents.Serialization/WritingPrintTicketRequiredEventArgs.xml b/xml/System.Windows.Documents.Serialization/WritingPrintTicketRequiredEventArgs.xml index d599e971e07..a07b57f5ec1 100644 --- a/xml/System.Windows.Documents.Serialization/WritingPrintTicketRequiredEventArgs.xml +++ b/xml/System.Windows.Documents.Serialization/WritingPrintTicketRequiredEventArgs.xml @@ -144,7 +144,7 @@ property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. + Setting the property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. ]]> @@ -198,7 +198,7 @@ property is , the property specifies the number of documents output with the . For other values, the property specifies the number of pages output with the . + When the property is , the property specifies the number of documents output with the . For other values, the property specifies the number of pages output with the . ]]> @@ -240,7 +240,7 @@ property is , the property specifies the number of documents output with the . For other values, the property specifies the number of pages output with the . + When the property is , the property specifies the number of documents output with the . For other values, the property specifies the number of pages output with the . ]]> diff --git a/xml/System.Windows.Documents.Serialization/WritingProgressChangedEventArgs.xml b/xml/System.Windows.Documents.Serialization/WritingProgressChangedEventArgs.xml index d7d9827cf5e..863cca079ff 100644 --- a/xml/System.Windows.Documents.Serialization/WritingProgressChangedEventArgs.xml +++ b/xml/System.Windows.Documents.Serialization/WritingProgressChangedEventArgs.xml @@ -73,7 +73,7 @@ method that identifies the asynchronous write operation. + The user-supplied `state` parameter is the object passed to method that identifies the asynchronous write operation. ]]> @@ -115,7 +115,7 @@ property is , specifies the number of documents that have been written. For all other cases, is the number of pages that have been written. + When the property is , specifies the number of documents that have been written. For all other cases, is the number of pages that have been written. ]]> @@ -157,7 +157,7 @@ property is , the property specifies the number of documents that have been written. For all other cases, the property is the number of pages that have been written. + When the property is , the property specifies the number of documents that have been written. For all other cases, the property is the number of pages that have been written. ]]> diff --git a/xml/System.Windows.Documents/Adorner.xml b/xml/System.Windows.Documents/Adorner.xml index 8c449c99f73..e9c2ca69d95 100644 --- a/xml/System.Windows.Documents/Adorner.xml +++ b/xml/System.Windows.Documents/Adorner.xml @@ -192,9 +192,9 @@ ## Remarks This implementation always returns `null`. - This method overrides . + This method overrides . - To ensure that adorners are always rendered topmost, clipping constraints are ignored unless is `true`. This enables an adorner to render outside of the adorned element's bounding rectangle. + To ensure that adorners are always rendered topmost, clipping constraints are ignored unless is `true`. This enables an adorner to render outside of the adorned element's bounding rectangle. ]]> @@ -285,7 +285,7 @@ ## Remarks By default, an adorner will size to match the adorned element. - This method overrides . + This method overrides . ]]> diff --git a/xml/System.Windows.Documents/AdornerDecorator.xml b/xml/System.Windows.Documents/AdornerDecorator.xml index 2671891b063..490550ad8e8 100644 --- a/xml/System.Windows.Documents/AdornerDecorator.xml +++ b/xml/System.Windows.Documents/AdornerDecorator.xml @@ -24,22 +24,22 @@ Provides an for the child elements in the visual tree. - can contain only one child element. That element can contain multiple elements that can be adorned. - - The specifies the position of the in the visual tree. It is typically used in a for a control that might host objects. For example, the of a contains an so that the child elements of the window can be adorned. The method returns `null` if you pass in an element that does not have an as an ancestor in its visual tree. - - For more information about adorners and visual trees, see [Adorners Overview](/dotnet/framework/wpf/controls/adorners-overview) and [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). - - - -## Examples - The following example creates a for a . The example adds a as the child element of an . The logical child elements of the window can be adorned because the is in their visual tree. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/window.xaml" id="Snippetwindow"::: - + can contain only one child element. That element can contain multiple elements that can be adorned. + + The specifies the position of the in the visual tree. It is typically used in a for a control that might host objects. For example, the of a contains an so that the child elements of the window can be adorned. The method returns `null` if you pass in an element that does not have an as an ancestor in its visual tree. + + For more information about adorners and visual trees, see [Adorners Overview](/dotnet/framework/wpf/controls/adorners-overview) and [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + + + +## Examples + The following example creates a for a . The example adds a as the child element of an . The logical child elements of the window can be adorned because the is in their visual tree. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/TemplateBindingExtension/Overview/window.xaml" id="Snippetwindow"::: + ]]> @@ -138,11 +138,11 @@ Positions child elements and determines a size for the . The actual size needed by the element. This return value is typically the same as the value passed to *finalSize*. - . - + . + ]]> @@ -175,11 +175,11 @@ Gets or sets the single child of an . The single child of an . This property has no default value. - can contain only one child, which is the parent element for the visual tree below the . - + can contain only one child, which is the parent element for the visual tree below the . + ]]> @@ -248,11 +248,11 @@ Measures the size required for child elements and determines a size for the . A object representing the amount of layout space needed by the . - . - + . + ]]> diff --git a/xml/System.Windows.Documents/AdornerLayer.xml b/xml/System.Windows.Documents/AdornerLayer.xml index cd5575ba998..4ac0303f267 100644 --- a/xml/System.Windows.Documents/AdornerLayer.xml +++ b/xml/System.Windows.Documents/AdornerLayer.xml @@ -155,7 +155,7 @@ . + This method overrides . ]]> @@ -270,7 +270,7 @@ children. The method must return the child at the specified index. The index must be between `0` and (`-1`). + A derived class must implement this method to support children. The method must return the child at the specified index. The index must be between `0` and (`-1`). ]]> @@ -342,7 +342,7 @@ ## Remarks The should be the same size as its parent and consume no layout space. - This method overrides . + This method overrides . ]]> diff --git a/xml/System.Windows.Documents/AnchoredBlock.xml b/xml/System.Windows.Documents/AnchoredBlock.xml index baa7fc8d748..fffa2c7d064 100644 --- a/xml/System.Windows.Documents/AnchoredBlock.xml +++ b/xml/System.Windows.Documents/AnchoredBlock.xml @@ -138,12 +138,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of an element (). + The following example shows how to set the attribute of an element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -267,12 +267,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -398,12 +398,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_lineheightxaml"::: @@ -411,7 +411,7 @@ ![Screenshot: FlowDocument LineHeight](~/add/media/flowdocument-lineheight.png "Screenshot: FlowDocument LineHeight") - The following figure shows how the same example renders with the default setting of =. + The following figure shows how the same example renders with the default setting of =. ![Screenshot: FlowDocument LineHeight default](~/add/media/flowdocument-lineheightdefault.png "Screenshot: FlowDocument LineHeight default") @@ -490,12 +490,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -567,7 +567,7 @@ is buffer space that falls outside of an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside of an element's content area, between the element's content and the inner edge of the element. + is buffer space that falls outside of an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside of an element's content area, between the element's content and the inner edge of the element. ## XAML Attribute Usage @@ -614,12 +614,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -696,7 +696,7 @@ is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside of an element's content area, between the edges of the element's content area and the edges of the parent element. + is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside of an element's content area, between the edges of the element's content area and the edges of the parent element. ## XAML Attribute Usage @@ -743,12 +743,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -873,12 +873,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_textalignmentxaml"::: diff --git a/xml/System.Windows.Documents/Block.xml b/xml/System.Windows.Documents/Block.xml index ff7af658589..deefd4f7864 100644 --- a/xml/System.Windows.Documents/Block.xml +++ b/xml/System.Windows.Documents/Block.xml @@ -109,12 +109,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -236,12 +236,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -325,7 +325,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -398,7 +398,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -471,7 +471,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -548,12 +548,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_flowdirectionxaml"::: @@ -783,12 +783,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_hyphenatexaml"::: @@ -796,7 +796,7 @@ ![Screenshot: FlowDocument hyphen enabled](~/add/media/flowdoc-hyphenenabled.png "Screenshot: FlowDocument hyphen enabled") - The following figure shows how the same example renders with the default setting of =`false`. + The following figure shows how the same example renders with the default setting of =`false`. ![Screenshot: FlowDocument with disabled hyphens](~/add/media/flowdoc-hyphendisabled.png "Screenshot: FlowDocument with disabled hyphens") @@ -917,12 +917,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_lineheightxaml"::: @@ -930,7 +930,7 @@ ![Screenshot: FlowDocument LineHeight](~/add/media/flowdocument-lineheight.png "Screenshot: FlowDocument LineHeight") - The following figure shows how the same renders with the default setting of =. + The following figure shows how the same renders with the default setting of =. ![Screenshot: FlowDocument LineHeight default](~/add/media/flowdocument-lineheightdefault.png "Screenshot: FlowDocument LineHeight default") @@ -1003,7 +1003,7 @@ `, where *object* is an object element (typically a flow element) contained within a derived class, and *value* is a string value of the enumeration. In code, the attached property usage is supported by the and methods. The attached property usage is not common. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a derived class, and *value* is a string value of the enumeration. In code, the attached property usage is supported by the and methods. The attached property usage is not common. ## Dependency Property Information @@ -1011,12 +1011,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -1086,7 +1086,7 @@ is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. + is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. ## XAML Attribute Usage @@ -1133,12 +1133,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -1245,7 +1245,7 @@ is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. + is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. ## XAML Attribute Usage @@ -1292,12 +1292,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -1522,7 +1522,7 @@ + ]]> @@ -1605,12 +1605,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_textalignmentxaml"::: diff --git a/xml/System.Windows.Documents/Bold.xml b/xml/System.Windows.Documents/Bold.xml index 7ee7bc66ece..c225aa3a394 100644 --- a/xml/System.Windows.Documents/Bold.xml +++ b/xml/System.Windows.Documents/Bold.xml @@ -25,13 +25,13 @@ An inline-level flow content element which causes content to render with a bold font weight. - enforces a strong content model for child content. See [TextElement Content Model Overview](/dotnet/framework/wpf/advanced/textelement-content-model-overview) for more information about the content model. - - The object is the equivalent of a with set to . - + enforces a strong content model for child content. See [TextElement Content Model Overview](/dotnet/framework/wpf/advanced/textelement-content-model-overview) for more information about the content model. + + The object is the equivalent of a with set to . + ]]> @@ -109,14 +109,14 @@ An object specifying the initial contents of the new . Initializes a new instance of the class, taking a specified object as the initial contents of the new . - @@ -156,14 +156,14 @@ A specifying an insertion position at which to insert the element after it is created, or for no automatic insertion. Initializes a new instance of the class, taking a specified object as the initial contents of the new , and a specifying an insertion position for the new element. - @@ -203,19 +203,19 @@ A indicating the end of a selection of content to be contained by the new . Initializes a new instance of the class, taking two objects that indicate the beginning and end of a selection of content to be contained by the new . - element such that it encloses a selection of pre-existing content. - - - -## Examples - The following example demonstrates usage of this constructor. - + element such that it encloses a selection of pre-existing content. + + + +## Examples + The following example demonstrates usage of this constructor. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/TextBlock/Text/Window1.xaml.cs" id="Snippet_bold_const3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/TextBlock/Text/window1.xaml.vb" id="Snippet_bold_const3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/TextBlock/Text/window1.xaml.vb" id="Snippet_bold_const3"::: + ]]> Raised when or is **null**. diff --git a/xml/System.Windows.Documents/DocumentPage.xml b/xml/System.Windows.Documents/DocumentPage.xml index 5931cf1ae55..31e82a7cfed 100644 --- a/xml/System.Windows.Documents/DocumentPage.xml +++ b/xml/System.Windows.Documents/DocumentPage.xml @@ -149,7 +149,7 @@ ## Remarks The bleed box will extend outside the page when it is expected that the physical sheets will be cropped to their final page size. - Use the protected method to set this property. + Use the protected method to set this property. ]]> @@ -186,7 +186,7 @@ method to set this property. + Use the protected method to set this property. ]]> @@ -225,10 +225,10 @@ when you are finished using the . The method leaves the in an unusable state. After calling you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + Call when you are finished using the . The method leaves the in an unusable state. After calling you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -265,7 +265,7 @@ ## Remarks Return the value when calling code requests a page that does not exist; for example, page 2 of a one-page document. - There is always just one missing page object. Its property is `null`. Its , , and properties are all set to special "empty" values. + There is always just one missing page object. Its property is `null`. Its , , and properties are all set to special "empty" values. ]]> @@ -365,7 +365,7 @@ and coordinates of the `bleedBox` parameter can be negative numbers, because they are specified as relative to the upper left corner of the page. For the same reason, the and of `bleedBox` can be greater than the height and width of the page. + The bleed box includes material, such as crop marks, that are not necessarily included in the final, post-cropping, physical page. For this reason, the and coordinates of the `bleedBox` parameter can be negative numbers, because they are specified as relative to the upper left corner of the page. For the same reason, the and of `bleedBox` can be greater than the height and width of the page. ]]> @@ -499,7 +499,7 @@ ## Remarks This property represents the post-cropping size of the physical page. Hence, it is not necessarily the physical size of the sheets before they are cropped. - Use the protected method to set this property. + Use the protected method to set this property. ]]> @@ -541,7 +541,7 @@ method to set this property. + Use the protected method to set this property. ]]> diff --git a/xml/System.Windows.Documents/DocumentPaginator.xml b/xml/System.Windows.Documents/DocumentPaginator.xml index 66cdea1f5a9..7ca7b13a013 100644 --- a/xml/System.Windows.Documents/DocumentPaginator.xml +++ b/xml/System.Windows.Documents/DocumentPaginator.xml @@ -133,7 +133,7 @@ will be `true` immediately after this is called. If content is modified or is changed after this method is called, will likely revert to `false`. + will be `true` immediately after this is called. If content is modified or is changed after this method is called, will likely revert to `false`. ]]> @@ -184,7 +184,7 @@ . + The only way to cancel the asynchronous operation of this method is to cancel all asynchronous operations. Contrast this with the other overload of this method: . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -298,7 +298,7 @@ ## Remarks If pages prior to `pageNumber` have not been formatted, they will be paginated synchronously prior to returning the requested page. - provides similar functionality as , but for asynchronous operation. + provides similar functionality as , but for asynchronous operation. ]]> @@ -354,9 +354,9 @@ . + The only way to cancel the asynchronous operation of this method is to cancel all asynchronous operations. Contrast this with the other overload of this method: . - This method raises the event. The is passed to the event as one of the event arguments. See for how to use this method to get the page. + This method raises the event. The is passed to the event as one of the event arguments. See for how to use this method to get the page. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -409,13 +409,13 @@ 1. Create a delegate and add it to be notified of events. -2. Call specifying the `pageNumber` desired and a unique `userState`, which will be used to identify the completion of the asynchronous event. +2. Call specifying the `pageNumber` desired and a unique `userState`, which will be used to identify the completion of the asynchronous event. -3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. (The . property will also match the `pageNumber` specified in the call.) +3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. (The . property will also match the `pageNumber` specified in the call.) -4. When the . property matches the original `userState`, the operation is complete and the page is ready. +4. When the . property matches the original `userState`, the operation is complete and the page is ready. -5. Call to retrieve the formatted . +5. Call to retrieve the formatted . ]]> @@ -612,11 +612,11 @@ is `true`, pagination is complete and is the total number of pages in the document. + If is `true`, pagination is complete and is the total number of pages in the document. - If is `false`, pagination is in process and is the number of pages currently formatted (not the total). + If is `false`, pagination is in process and is the number of pages currently formatted (not the total). - This value may change if or content changes, because those events would force a repagination. + This value may change if or content changes, because those events would force a repagination. ]]> @@ -683,12 +683,12 @@ may override the value of this property. Users should check . + The may override the value of this property. Users should check . ## Examples - The following example shows how to set the . + The following example shows how to set the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpfContent.cs" id="Snippetcreatefixeddocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpfcontent.vb" id="Snippetcreatefixeddocument"::: diff --git a/xml/System.Windows.Documents/DocumentReference.xml b/xml/System.Windows.Documents/DocumentReference.xml index ab06aa2e9f4..462555359be 100644 --- a/xml/System.Windows.Documents/DocumentReference.xml +++ b/xml/System.Windows.Documents/DocumentReference.xml @@ -97,7 +97,7 @@ will load the document regardless if the `forceReload` parameter is `true` or `false`. + If the document has not been loaded previously, will load the document regardless if the `forceReload` parameter is `true` or `false`. If the document was loaded previously and `forceReload` is specified as `false`, the document is not reloaded and the previously loaded document is returned. diff --git a/xml/System.Windows.Documents/DocumentReferenceCollection.xml b/xml/System.Windows.Documents/DocumentReferenceCollection.xml index a6f3b4722dd..d60402f917b 100644 --- a/xml/System.Windows.Documents/DocumentReferenceCollection.xml +++ b/xml/System.Windows.Documents/DocumentReferenceCollection.xml @@ -40,11 +40,11 @@ Defines an ordered list of elements. - , the order of the elements that the contains should be the same as the document order that is defined in the . - + , the order of the elements that the contains should be the same as the document order that is defined in the . + ]]> @@ -79,11 +79,11 @@ The element to add to the end of the collection. Adds an element to the end of the collection. - . - + . + ]]> @@ -155,11 +155,11 @@ The zero-based starting index within the array where the collection elements are to be copied. Copies the whole collection to an array that starts at a given array index. - . - + . + ]]> @@ -257,11 +257,11 @@ Gets the element that is at the specified index. The collection element that is at the specified . - .. - + .. + ]]> diff --git a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml index 7ede80bb028..a81cc87d371 100644 --- a/xml/System.Windows.Documents/DynamicDocumentPaginator.xml +++ b/xml/System.Windows.Documents/DynamicDocumentPaginator.xml @@ -27,21 +27,21 @@ will automatically pre-paginate content in the background (this process begins when is `true`, which is the default setting). + By default, a will automatically pre-paginate content in the background (this process begins when is `true`, which is the default setting). - When is `true`, the layout will also be repaginated due to changes in content or changes in . + When is `true`, the layout will also be repaginated due to changes in content or changes in . The event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations: - events occur as content is paginated in the background. Depending on the implementation, the event may occur upon paginating one or multiple pages ( specifies which pages have been paginated). -- Calls to or may cause an event to occur if the page specified has not been paginated. For example, if background pagination is enabled ( = `true`) but pagination has only been completed up to the third page, a call of with an argument of 6 will cause pages four, five, six, and seven to be paginated. Upon completion, a event will be raised with settings of = 4 and = 4. +- Calls to or may cause an event to occur if the page specified has not been paginated. For example, if background pagination is enabled ( = `true`) but pagination has only been completed up to the third page, a call of with an argument of 6 will cause pages four, five, six, and seven to be paginated. Upon completion, a event will be raised with settings of = 4 and = 4. -- With background pagination enabled ( = `true`), a change in on flow-format content, such as a , may cause repagination and associated events. Note that has no effect in repagination on fixed-format content, such as , where the visual page size does not affect the layout. +- With background pagination enabled ( = `true`), a change in on flow-format content, such as a , may cause repagination and associated events. Note that has no effect in repagination on fixed-format content, such as , where the visual page size does not affect the layout. - A event also occurs when background pagination is disabled. For example, if there is only one page of content and = `false`), calling with an argument of 0 will result in two events: + A event also occurs when background pagination is disabled. For example, if there is only one page of content and = `false`), calling with an argument of 0 will result in two events: -1. A event with settings of = 0 and = 1. +1. A event with settings of = 0 and = 1. 2. A event. @@ -149,7 +149,7 @@ ## Remarks If pages prior to the `contentPosition` have not been formatted, they will be paginated synchronously prior to returning the requested page number. - provides similar functionality as , but with asynchronous operation. + provides similar functionality as , but with asynchronous operation. ]]> @@ -203,9 +203,9 @@ . + The only way to cancel the asynchronous operation of this method is to cancel all asynchronous operations. Contrast this with the other overload of this method: . - This method raises the event. The page number is passed to the event as one of the event arguments. See for how to use this method to get the page number. + This method raises the event. The page number is passed to the event as one of the event arguments. See for how to use this method to get the page number. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -256,15 +256,15 @@ 1. Create a delegate and add it to be notified of events. -2. Call specifying the `contentPosition` desired and a unique `userState` object that will be used to identify the asynchronous task. +2. Call specifying the `contentPosition` desired and a unique `userState` object that will be used to identify the asynchronous task. -3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. +3. When the event occurs and the delegate is called, compare the event's . property with the original `userState` parameter. -4. When the . property matches the original `userState`, the operation is complete and the page number is ready. (The . property will also match the original `contentPosition` parameter.) +4. When the . property matches the original `userState`, the operation is complete and the page number is ready. (The . property will also match the original `contentPosition` parameter.) 5. The . property contains the zero-based page number of the specified `contentPosition`. - provides similar functionality as , but for synchronous operation. + provides similar functionality as , but for synchronous operation. ]]> @@ -365,7 +365,7 @@ ## Remarks When `true`, pagination is performed in the background, raising and events as appropriate. - Pagination of content, as distinct from a is not affected by changes to the visual . + Pagination of content, as distinct from a is not affected by changes to the visual . ]]> @@ -499,7 +499,7 @@ occurs, is `true` until a new pagination is initiated. + When occurs, is `true` until a new pagination is initiated. ]]> @@ -535,7 +535,7 @@ properties and identify the range of pages paginated. + properties and identify the range of pages paginated. ]]> diff --git a/xml/System.Windows.Documents/EditingCommands.xml b/xml/System.Windows.Documents/EditingCommands.xml index c357bf78257..2e59098dbf7 100644 --- a/xml/System.Windows.Documents/EditingCommands.xml +++ b/xml/System.Windows.Documents/EditingCommands.xml @@ -31,64 +31,64 @@ |Editing command|Default key gesture| |---------------------|-------------------------| -||`Ctrl`+`E`| -||`Ctrl`+`J`| -||`Ctrl`+`L`| -||`Ctrl`+`R`| -||`Backspace`| -||no default key gesture| -||`Ctrl`+`OemOpenBrackets`| -||`Ctrl`+`Shift`+`T`| -||`Delete`| -||`Ctrl`+`Delete`| -||`Ctrl`+`Backspace`| -||`Shift`+`Enter`| -||`Enter`| -||no default key gesture| -||`Ctrl`+`OemCloseBrackets`| -||`Ctrl`+`T`| -||`Down`| -||`PageDown`| -||`Ctrl`+`Down`| -||`Left`| -||`Ctrl`+`Left`| -||`Right`| -||`Ctrl`+`Right`| -||`Ctrl`+`End`| -||`Ctrl`+`Home`| -||`End`| -||`Home`| -||`Up`| -||`PageUp`| -||`Ctrl`+`Up`| -||`Shift`+`Down`| -||`Shift`+`PageDown`| -||`Ctrl`+`Shift`+`Down`| -||`Shift`+`Left`| -||`Ctrl`+`Shift`+`Left`| -||`Shift`+`Right`| -||`Ctrl`+`Shift`+`Right`| -||`Ctrl`+`Shift`+`End`| -||`Ctrl`+`Shift`+`Home`| -||`Shift`+`End`| -||`Shift`+`Home`| -||`Shift`+`Up`| -||`Shift`+`PageUp`| -||`Ctrl`+`Shift`+`Up`| -||`Shift`+`Tab`| -||`Tab`| -||`Ctrl`+`B`| -||`Ctrl`+`Shift`+`L`| -||`Insert`| -||`Ctrl`+`I`| -||`Ctrl`+`Shift`+`N`| -||`Ctrl`+`OemPlus`| -||`Ctrl`+`Shift+OemPlus`| -||`Ctrl`+`U`| - - Caret movement commands and selection expanding commands share a common set of default key gestures, the general difference being the addition of the key to differentiate selection commands from caret movement commands. For example, the command has a default key gesture of , and the corresponding command has a default key gesture of +. - - In general, the command definitions provided by the class do not make use of command parameters (the `parameter` parameter expected by the method). +||`Ctrl`+`E`| +||`Ctrl`+`J`| +||`Ctrl`+`L`| +||`Ctrl`+`R`| +||`Backspace`| +||no default key gesture| +||`Ctrl`+`OemOpenBrackets`| +||`Ctrl`+`Shift`+`T`| +||`Delete`| +||`Ctrl`+`Delete`| +||`Ctrl`+`Backspace`| +||`Shift`+`Enter`| +||`Enter`| +||no default key gesture| +||`Ctrl`+`OemCloseBrackets`| +||`Ctrl`+`T`| +||`Down`| +||`PageDown`| +||`Ctrl`+`Down`| +||`Left`| +||`Ctrl`+`Left`| +||`Right`| +||`Ctrl`+`Right`| +||`Ctrl`+`End`| +||`Ctrl`+`Home`| +||`End`| +||`Home`| +||`Up`| +||`PageUp`| +||`Ctrl`+`Up`| +||`Shift`+`Down`| +||`Shift`+`PageDown`| +||`Ctrl`+`Shift`+`Down`| +||`Shift`+`Left`| +||`Ctrl`+`Shift`+`Left`| +||`Shift`+`Right`| +||`Ctrl`+`Shift`+`Right`| +||`Ctrl`+`Shift`+`End`| +||`Ctrl`+`Shift`+`Home`| +||`Shift`+`End`| +||`Shift`+`Home`| +||`Shift`+`Up`| +||`Shift`+`PageUp`| +||`Ctrl`+`Shift`+`Up`| +||`Shift`+`Tab`| +||`Tab`| +||`Ctrl`+`B`| +||`Ctrl`+`Shift`+`L`| +||`Insert`| +||`Ctrl`+`I`| +||`Ctrl`+`Shift`+`N`| +||`Ctrl`+`OemPlus`| +||`Ctrl`+`Shift+OemPlus`| +||`Ctrl`+`U`| + + Caret movement commands and selection expanding commands share a common set of default key gestures, the general difference being the addition of the key to differentiate selection commands from caret movement commands. For example, the command has a default key gesture of , and the corresponding command has a default key gesture of +. + + In general, the command definitions provided by the class do not make use of command parameters (the `parameter` parameter expected by the method). For more information on commands and commanding, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -99,7 +99,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -170,7 +170,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -246,7 +246,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -314,7 +314,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -382,7 +382,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -428,7 +428,7 @@ ## Remarks When invoked on an empty selection, this command deletes the character or paragraph separator just before the caret. When invoked on a non-empty selection, this command deletes the selection. - This command retains any formatting from the deleted selection for content immediately inserted at the same location after this command is invoked. Contrast with the command, which does not retain previous formatting. + This command retains any formatting from the deleted selection for content immediately inserted at the same location after this command is invoked. Contrast with the command, which does not retain previous formatting. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -448,7 +448,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -553,7 +553,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -616,7 +616,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -658,7 +658,7 @@ command, which retains any formatting from the deleted selection for content immediately inserted at the same location after this command is invoked. + This command discards any formatting from the deleted selection. Contrast with the command, which retains any formatting from the deleted selection for content immediately inserted at the same location after this command is invoked. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -678,7 +678,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -739,7 +739,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -805,7 +805,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -871,7 +871,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -936,7 +936,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1042,7 +1042,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1105,7 +1105,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1165,7 +1165,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1228,7 +1228,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1275,7 +1275,7 @@ ## Remarks This command positions the caret at the beginning of the next paragraph. - This command behaves like when invoked on a . + This command behaves like when invoked on a . There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -1295,7 +1295,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1358,7 +1358,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1422,7 +1422,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1484,7 +1484,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1548,7 +1548,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1612,7 +1612,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1675,7 +1675,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1736,7 +1736,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1797,7 +1797,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1858,7 +1858,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1921,7 +1921,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -1968,7 +1968,7 @@ ## Remarks This command positions the caret at the beginning of the next paragraph. - This command behaves like when invoked on a . + This command behaves like when invoked on a . There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -1988,7 +1988,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2051,7 +2051,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2114,7 +2114,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2179,7 +2179,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2242,7 +2242,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2288,7 +2288,7 @@ ## Remarks If the caret is within a word, this command expands the selection to the beginning of that word. Otherwise, this command expands the selection to the beginning of the previous word. - The expanded selection does not include the word delimiter. Contrast with , which does include the word delimiter in the expanded selection. + The expanded selection does not include the word delimiter. Contrast with , which does include the word delimiter in the expanded selection. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -2308,7 +2308,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2370,7 +2370,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2416,7 +2416,7 @@ ## Remarks If the caret is within a word, this command expands the selection to the end of that word. Otherwise, this command expands the selection to the end of the next word. - The expanded selection includes the word delimiter. Contrast with which does not include the word delimiter in the expanded selection. + The expanded selection includes the word delimiter. Contrast with which does not include the word delimiter in the expanded selection. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -2436,7 +2436,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2500,7 +2500,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2563,7 +2563,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2624,7 +2624,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2685,7 +2685,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2746,7 +2746,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2809,7 +2809,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2874,7 +2874,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2919,7 +2919,7 @@ . If the caret is in a table cell (represented by the element), this command moves the caret to the previous cell. Otherwise, a tab character is inserted in current position. + The behavior for this command depends on the current selection. If the selection is non-empty, this command is equivalent to . If the caret is in a table cell (represented by the element), this command moves the caret to the previous cell. Otherwise, a tab character is inserted in current position. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -2939,7 +2939,7 @@ For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -2990,7 +2990,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) . If the caret is in a table cell (represented by the element), this command moves the caret to the next cell. If the caret is in the last cell of a table, this command causes a new row to be appended to the table, with the caret positioned in the first cell of the new row. Otherwise, a tab character is inserted in current position. + The behavior for this command depends on the current selection. If the selection is non-empty, or if the selection is empty and the current caret position is at the beginning of a paragraph, this command is equivalent to . If the caret is in a table cell (represented by the element), this command moves the caret to the next cell. If the caret is in the last cell of a table, this command causes a new row to be appended to the table, with the caret positioned in the first cell of the new row. Otherwise, a tab character is inserted in current position. There is not necessarily an actual implementation that responds to this command on any given object; in many cases the implementation that responds to a command is the responsibility of the application writer. @@ -3010,7 +3010,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3061,7 +3061,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) for the current selection is in the range from to , is applied to the current selection. Otherwise, is applied. For a comparative list of values, see . + If the for the current selection is in the range from to , is applied to the current selection. Otherwise, is applied. For a comparative list of values, see . When the selection is empty and the caret is within a word, the selection is expanded to include the entire word. @@ -3083,7 +3083,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3146,7 +3146,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3206,7 +3206,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3247,7 +3247,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) for the current selection is , is applied to the current selection. Otherwise, is applied. + If the for the current selection is , is applied to the current selection. Otherwise, is applied. When the selection is empty and the caret is within a word, the selection is expanded to include the entire word. @@ -3269,7 +3269,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3332,7 +3332,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3390,7 +3390,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3448,7 +3448,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. @@ -3510,7 +3510,7 @@ EditingCommands.ToggleInsert.Execute(Nothing, rTB) For this example, a serves as the command target. Note that implements the interface (inherited from ), and that it includes native support for many editing commands. - The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. + The first argument for the method is a command parameter. Most editing commands ignore the command parameter; in general, this parameter should be `null` for editing commands. The second argument specifies the object to which the command will be routed. This object must implement the interface, and should include a handler for the specified command. Generally, a command is ignored when invoked on an object that does not handle the command. diff --git a/xml/System.Windows.Documents/Figure.xml b/xml/System.Windows.Documents/Figure.xml index 47583e0d196..8a8c344c40d 100644 --- a/xml/System.Windows.Documents/Figure.xml +++ b/xml/System.Windows.Documents/Figure.xml @@ -35,7 +35,7 @@ **Figure:** -- Can be positioned: You can set its horizontal and vertical anchors to dock it relative to the page, content, column or paragraph. You can also use its and properties to specify arbitrary offsets. +- Can be positioned: You can set its horizontal and vertical anchors to dock it relative to the page, content, column or paragraph. You can also use its and properties to specify arbitrary offsets. - Is sizable to more than one column: You can set height and width to multiples of page, content or column height or width. Note that in the case of page and content, multiples greater than 1 are not allowed. For example, you can set the width of a to be "0.5 page" or "0.25 content" or "2 Column". You can also set height and width to absolute pixel values. @@ -237,7 +237,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -310,12 +310,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -395,12 +395,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -513,12 +513,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -598,12 +598,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -716,12 +716,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -801,12 +801,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: @@ -886,12 +886,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: diff --git a/xml/System.Windows.Documents/FixedDocument.xml b/xml/System.Windows.Documents/FixedDocument.xml index 248ee9e8ee0..30dd0b1a39b 100644 --- a/xml/System.Windows.Documents/FixedDocument.xml +++ b/xml/System.Windows.Documents/FixedDocument.xml @@ -288,7 +288,7 @@ ## Remarks A contains printing information such as whether to print on both sides of each sheet. - Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. + Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. ## Dependency Property Information diff --git a/xml/System.Windows.Documents/FixedDocumentSequence.xml b/xml/System.Windows.Documents/FixedDocumentSequence.xml index b1a2c81800b..056d1d1c1f5 100644 --- a/xml/System.Windows.Documents/FixedDocumentSequence.xml +++ b/xml/System.Windows.Documents/FixedDocumentSequence.xml @@ -57,7 +57,7 @@ ## Examples - The following example show how to obtain the of an by use of the method. + The following example show how to obtain the of an by use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/Window1.xaml.cs" id="Snippetxpssaveloadfixedcontent"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/window1.xaml.vb" id="Snippetxpssaveloadfixedcontent"::: @@ -230,7 +230,7 @@ ## Remarks A contains printing information such as whether to print on both sides of each sheet. - Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. + Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. ## Dependency Property Information diff --git a/xml/System.Windows.Documents/FixedPage.xml b/xml/System.Windows.Documents/FixedPage.xml index 763d5047c18..348f6d24644 100644 --- a/xml/System.Windows.Documents/FixedPage.xml +++ b/xml/System.Windows.Documents/FixedPage.xml @@ -162,7 +162,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -235,17 +235,17 @@ is used to specify an expanded area for print production-related bleeds, registration marks, and crop marks that may extend outside the logical page. The logical page is the part of the sheet that will remain after it has been cropped to its final size. So the dimensions of the bleed box can be no smaller than the logical page size, but may be greater. Contrast the with the which is the area of the page on which content can appear; that is, the part of the page that is *within* the margins. So the dimensions of the content box can be no larger than the page, but may be smaller. + is used to specify an expanded area for print production-related bleeds, registration marks, and crop marks that may extend outside the logical page. The logical page is the part of the sheet that will remain after it has been cropped to its final size. So the dimensions of the bleed box can be no smaller than the logical page size, but may be greater. Contrast the with the which is the area of the page on which content can appear; that is, the part of the page that is *within* the margins. So the dimensions of the content box can be no larger than the page, but may be smaller. - The and properties of both the bleed box and the content box are measured from the left and the and properties are measured from the top. Hence, the following rules must be enforced in defining the and : + The and properties of both the bleed box and the content box are measured from the left and the and properties are measured from the top. Hence, the following rules must be enforced in defining the and : -- . must be less than or equal to .. +- . must be less than or equal to .. -- . must be less than or equal to .. +- . must be less than or equal to .. -- . must be greater than or equal to .. +- . must be greater than or equal to .. -- . must be greater than or equal to .. +- . must be greater than or equal to .. ## Dependency Property Information @@ -314,7 +314,7 @@ returns . + If the bottom offset has not been set, returns . ## Dependency Property Information @@ -322,7 +322,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -395,9 +395,9 @@ returns `null` if the is data-bound and child elements cannot be added or removed manually. + returns `null` if the is data-bound and child elements cannot be added or removed manually. - In non data-bound uses, allows the application to manually or child elements. + In non data-bound uses, allows the application to manually or child elements. ]]> @@ -433,17 +433,17 @@ : + The following rules must be enforced in defining the : -- . must be greater than or equal to zero (0), and less than or equal to (.-1). +- . must be greater than or equal to zero (0), and less than or equal to (.-1). -- . must be greater than or equal to zero (0), and less than or equal to (.-1). +- . must be greater than or equal to zero (0), and less than or equal to (.-1). -- . must be greater than or equal to (.+1). +- . must be greater than or equal to (.+1). -- . must be greater than or equal to (.+1). +- . must be greater than or equal to (.+1). -- For rules about the relative sizes of the and the , see the topic . +- For rules about the relative sizes of the and the , see the topic . ## Dependency Property Information @@ -535,7 +535,7 @@ returns . + If the bottom offset has not been set, returns . ]]> @@ -596,7 +596,7 @@ returns . + If the left offset has not been set, returns . ]]> @@ -649,7 +649,7 @@ returns `null`. + If the attached property has not been set, returns `null`. ]]> @@ -704,7 +704,7 @@ returns . + If the right offset has not been set, returns . ]]> @@ -765,7 +765,7 @@ returns . + If the top offset has not been set, returns . ]]> @@ -836,7 +836,7 @@ returns . + If the left offset has not been set, returns . ## Dependency Property Information @@ -844,7 +844,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -968,9 +968,9 @@ returns `null`. When you set the on one of the objects listed, the application attempts to navigate to the value specified when the object is clicked. + If a URI has not been set, returns `null`. When you set the on one of the objects listed, the application attempts to navigate to the value specified when the object is clicked. - You can use the attached property from the following objects: , , , and . + You can use the attached property from the following objects: , , , and . ## Dependency Property Information @@ -1170,7 +1170,7 @@ ## Remarks A contains information about how material should be printed; for example, whether or not two-sided printing should be used. - Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. + Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. ## Dependency Property Information @@ -1238,7 +1238,7 @@ returns . + If the right offset has not been set, returns . ## Dependency Property Information @@ -1246,7 +1246,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1379,7 +1379,7 @@ ## Examples - The following example shows use of the method. + The following example shows use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpfContent.cs" id="Snippetxpssavecreatefixedpage5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpfcontent.vb" id="Snippetxpssavecreatefixedpage5"::: @@ -1525,7 +1525,7 @@ ## Examples - The following example shows use of the method. + The following example shows use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpfContent.cs" id="Snippetxpssavecreatefixedpage5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpfcontent.vb" id="Snippetxpssavecreatefixedpage5"::: @@ -1668,7 +1668,7 @@ returns . + If the top offset has not been set, returns . ## Dependency Property Information @@ -1676,7 +1676,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Documents/Floater.xml b/xml/System.Windows.Documents/Floater.xml index 35904e164fa..c934aa2e4da 100644 --- a/xml/System.Windows.Documents/Floater.xml +++ b/xml/System.Windows.Documents/Floater.xml @@ -34,7 +34,7 @@ **Figure:** -- Can be positioned: You can set its horizontal and vertical anchors to dock it relative to the page, content, column or paragraph. You can also use its and properties to specify arbitrary offsets. +- Can be positioned: You can set its horizontal and vertical anchors to dock it relative to the page, content, column or paragraph. You can also use its and properties to specify arbitrary offsets. - Is sizable to more than one column: You can set height and width to multiples of page, content or column height or width. Note that in the case of page and content, multiples greater than 1 are not allowed. For example, you can set the width of a to be "0.5 page" or "0.25 content" or "2 Column". You can also set height and width to absolute pixel values. @@ -235,7 +235,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -354,12 +354,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_floaterpropsxaml"::: diff --git a/xml/System.Windows.Documents/FlowDocument.xml b/xml/System.Windows.Documents/FlowDocument.xml index 60cc5889e40..1dc5e308886 100644 --- a/xml/System.Windows.Documents/FlowDocument.xml +++ b/xml/System.Windows.Documents/FlowDocument.xml @@ -190,12 +190,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentbackgroundxaml"::: @@ -332,9 +332,9 @@ ## Remarks Getting this property returns the current column gap. Setting this value changes the currently effective column gap, and may cause content to reflow. - The column gap cannot exceed the current minus any . If the value of the property exceeds this limit, the effective column gap is reduced to observe this limit. + The column gap cannot exceed the current minus any . If the value of the property exceeds this limit, the effective column gap is reduced to observe this limit. - This property has no effect if is `null`. + This property has no effect if is `null`. ## XAML Attribute Usage @@ -374,7 +374,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -462,7 +462,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -550,7 +550,7 @@ This property has no effect if the property is `null`. - Column rules are only displayed when there are two or more columns. The column rule width is constrained to be less than or equal to the . + Column rules are only displayed when there are two or more columns. The column rule width is constrained to be less than or equal to the . ## XAML Attribute Usage @@ -585,7 +585,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -703,7 +703,7 @@ `pt` is points; 1pt==(96/72) px Auto - Causes column width to be automatically calculated to be 20 times the current . + Causes column width to be automatically calculated to be 20 times the current . ## Dependency Property Information @@ -711,12 +711,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentcolumnwidthxaml"::: @@ -789,7 +789,7 @@ ## Remarks The property is often used to append content to the end of a . - The returned by this property always has its set to . + The returned by this property always has its set to . @@ -836,7 +836,7 @@ ## Remarks The property is often used to insert content to the beginning of a . - The returned by this property always has its set to . + The returned by this property always has its set to . @@ -883,7 +883,7 @@ ## Remarks Getting this property returns the currently effective flow direction. Setting this property causes the contents of the to reflow in the indicated direction. - The of content typically corresponds to the innate flow direction of the language being represented. Hebrew and Arabic are examples of languages that naturally flow from right to left. English, German, and Russian are examples of languages that naturally flow from left to right. + The of content typically corresponds to the innate flow direction of the language being represented. Hebrew and Arabic are examples of languages that naturally flow from right to left. English, German, and Russian are examples of languages that naturally flow from left to right. > [!NOTE] > The value of this property is not automatically changed to match the language used by the operating system. If you need to use a different value then the default of , you must specify it yourself. @@ -894,12 +894,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentflowdirectionxaml"::: @@ -976,11 +976,11 @@ settings on child elements will override this top-level setting. + Any settings on child elements will override this top-level setting. When multiple families are specified, the second and subsequent font families serve as fallback families to be used in cases where the primary font family is unavailable or not applicable. - This property specifies a preference only. If the specified font family is not available, the will silently fall back to the font determined by the value. + This property specifies a preference only. If the specified font family is not available, the will silently fall back to the font determined by the value. ## XAML Attribute Usage @@ -1015,12 +1015,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentfontstuffxaml"::: @@ -1101,7 +1101,7 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. ## XAML Attribute Usage @@ -1136,12 +1136,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentfontstuffxaml"::: @@ -1212,7 +1212,7 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. ## Dependency Property Information @@ -1220,12 +1220,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentfontstuffxaml"::: @@ -1296,7 +1296,7 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. ## Dependency Property Information @@ -1304,12 +1304,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentfontstuffxaml"::: @@ -1380,7 +1380,7 @@ settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. ## Dependency Property Information @@ -1388,12 +1388,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentfontstuffxaml"::: @@ -1466,7 +1466,7 @@ ## Remarks For a table of swatches that shows the available predefined brush colors, see . - Any settings on child elements override this top-level setting. + Any settings on child elements override this top-level setting. ## Dependency Property Information @@ -1474,12 +1474,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, ,

| +|Metadata properties set to `true`|, ,

| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentbackgroundxaml"::: @@ -1551,7 +1551,7 @@ property determines the manner in which any excess content area width (that is, the difference between the page width and the width of the content after it is laid out) is distributed among columns. A setting of `true` means that the extra space is distributed equally to each column; in this case, columns may be sized wider than the width specified by the property. A setting of `false` means excess space is distributed to the padding on the right side of the page; in this case, columns will always size to the width specified by the property (so long as that width is smaller than the width of the page minus any ). + The property determines the manner in which any excess content area width (that is, the difference between the page width and the width of the content after it is laid out) is distributed among columns. A setting of `true` means that the extra space is distributed equally to each column; in this case, columns may be sized wider than the width specified by the property. A setting of `false` means excess space is distributed to the padding on the right side of the page; in this case, columns will always size to the width specified by the property (so long as that width is smaller than the width of the page minus any ). The following figure illustrates the difference in layout when this property is `true` or `false`. Light blue represents columns of content in a . @@ -1563,12 +1563,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentcolumnflexxaml"::: @@ -1677,12 +1677,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumenthyphenatexaml"::: @@ -1690,7 +1690,7 @@ ![Screenshot: FlowDocument hyphen enabled](~/add/media/flowdoc-hyphenenabled.png "Screenshot: FlowDocument hyphen enabled") - The following figure shows how the same renders with the default setting of =`false`. + The following figure shows how the same renders with the default setting of =`false`. ![Screenshot: FlowDocument with disabled hyphens](~/add/media/flowdoc-hyphendisabled.png "Screenshot: FlowDocument with disabled hyphens") @@ -1770,12 +1770,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumenthyphenatexaml"::: @@ -1783,7 +1783,7 @@ ![Screenshot: FlowDocument hyphen enabled](~/add/media/flowdoc-hyphenenabled.png "Screenshot: FlowDocument hyphen enabled") - The following figure shows how the same renders with the default setting of =`false`. + The following figure shows how the same renders with the default setting of =`false`. ![Screenshot: FlowDocument with disabled hyphens](~/add/media/flowdoc-hyphendisabled.png "Screenshot: FlowDocument with disabled hyphens") @@ -1902,12 +1902,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentlineheightxaml"::: @@ -1915,7 +1915,7 @@ ![Screenshot: FlowDocument LineHeight](~/add/media/flowdocument-lineheight.png "Screenshot: FlowDocument LineHeight") - The following figure shows how the same renders with the default setting of =. + The following figure shows how the same renders with the default setting of =. ![Screenshot: FlowDocument LineHeight default](~/add/media/flowdocument-lineheightdefault.png "Screenshot: FlowDocument LineHeight default") @@ -1995,12 +1995,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -2107,7 +2107,7 @@ ## Remarks If viewed on a continuum, the property takes precedence over the property, which in turn takes precedence over the property. If all three properties are set on a given page, this is the order in which the properties are evaluated. - This property has no effect when is set to (auto). + This property has no effect when is set to (auto). ## XAML Attribute Usage @@ -2142,12 +2142,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -2226,7 +2226,7 @@ ## Remarks If viewed on a continuum, the property takes precedence over the property, which in turn takes precedence over the property. If all three properties are set on a given page, this is the order in which the properties are evaluated. - This property has no effect when is set to (auto). + This property has no effect when is set to (auto). ## XAML Attribute Usage @@ -2261,12 +2261,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -2345,7 +2345,7 @@ ## Remarks If viewed on a continuum, the property takes precedence over the property, which in turn takes precedence over the property. If all three properties are set on a given page, this is the order in which the properties are evaluated. - This property has no effect when is set to (auto). + This property has no effect when is set to (auto). ## XAML Attribute Usage @@ -2380,12 +2380,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -2464,7 +2464,7 @@ ## Remarks If viewed on a continuum, the property takes precedence over the property, which in turn takes precedence over the property. If all three properties are set on a given page, this is the order in which the properties are evaluated. - This property has no effect when is set to (auto). + This property has no effect when is set to (auto). ## XAML Attribute Usage @@ -2499,12 +2499,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -2615,7 +2615,7 @@ . + This method overrides . ]]> @@ -2698,12 +2698,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -2774,7 +2774,7 @@ can be described as uniform in all directions (`PagePadding="10"`), or as four distinct values that represent left, top, right, and bottom padding independently (`PagePadding="5,0,10,20"`). + can be described as uniform in all directions (`PagePadding="10"`), or as four distinct values that represent left, top, right, and bottom padding independently (`PagePadding="5,0,10,20"`). If a specified padding thickness exceeds the corresponding page dimension (for example, the sum of the left and right padding widths exceeds the page width), the thickness of the padding will be proportionally reduced to be no greater than the relevant page dimension. @@ -2823,12 +2823,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following examples show various ways to set the attribute of a element. + The following examples show various ways to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpaddingxaml"::: @@ -2945,12 +2945,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumentpagewidthheightxaml"::: @@ -3208,12 +3208,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumenttextalignmentxaml"::: @@ -3303,7 +3303,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3372,7 +3372,7 @@ ## Examples - The following example shows how to set various typography variations with the attribute of a element. + The following example shows how to set various typography variations with the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/TextAlignment/Overview/Window1.xaml" id="Snippet_flowdocumenttypographyxaml"::: diff --git a/xml/System.Windows.Documents/FrameworkTextComposition.xml b/xml/System.Windows.Documents/FrameworkTextComposition.xml index 6cad3d4522e..91ca3f9dba1 100644 --- a/xml/System.Windows.Documents/FrameworkTextComposition.xml +++ b/xml/System.Windows.Documents/FrameworkTextComposition.xml @@ -29,7 +29,7 @@ ## Remarks The property is a when the user enters text into a by using an Input Method Editor (IME) and the , , or event occurs. - is the base class of . The class defines properties that return objects to indicate the position of the text composition. When the user enters text into a , is a . + is the base class of . The class defines properties that return objects to indicate the position of the text composition. When the user enters text into a , is a . ]]> @@ -100,9 +100,9 @@ property indicates how many characters have been entered since the last event. This property is only meaningful when the or event occurs. When the event occurs, is -1, and the property indicates the length of the composition. + The property indicates how many characters have been entered since the last event. This property is only meaningful when the or event occurs. When the event occurs, is -1, and the property indicates the length of the composition. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -138,9 +138,9 @@ or event occurs. When the event occurs, is -1, and the property indicates the position of the composition text. + This property is only meaningful when the or event occurs. When the event occurs, is -1, and the property indicates the position of the composition text. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -176,9 +176,9 @@ or event occurs, is -1. + When the or event occurs, is -1. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -214,9 +214,9 @@ or event occurs, is -1. + When the or event occurs, is -1. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Documents/GetPageCompletedEventArgs.xml b/xml/System.Windows.Documents/GetPageCompletedEventArgs.xml index a1c9cd966b6..ec003887eb3 100644 --- a/xml/System.Windows.Documents/GetPageCompletedEventArgs.xml +++ b/xml/System.Windows.Documents/GetPageCompletedEventArgs.xml @@ -72,7 +72,7 @@ . + The asynchronous operation can be canceled by calling . ]]> @@ -110,7 +110,7 @@ property identifies the page number of the requested . + The property identifies the page number of the requested . ]]> @@ -148,7 +148,7 @@ property contains the document page for the requested . + The property contains the document page for the requested . ]]> diff --git a/xml/System.Windows.Documents/GetPageNumberCompletedEventArgs.xml b/xml/System.Windows.Documents/GetPageNumberCompletedEventArgs.xml index 73d625b8c1a..e0f70767994 100644 --- a/xml/System.Windows.Documents/GetPageNumberCompletedEventArgs.xml +++ b/xml/System.Windows.Documents/GetPageNumberCompletedEventArgs.xml @@ -71,7 +71,7 @@ . + The asynchronous operation can be canceled by calling . ]]> @@ -144,7 +144,7 @@ property contains the passed to . + The property contains the passed to . ]]> diff --git a/xml/System.Windows.Documents/Glyphs.xml b/xml/System.Windows.Documents/Glyphs.xml index 73773b07314..9136b37dadb 100644 --- a/xml/System.Windows.Documents/Glyphs.xml +++ b/xml/System.Windows.Documents/Glyphs.xml @@ -139,7 +139,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -211,7 +211,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -275,7 +275,7 @@ Various typographic qualities of two different glyph characters is rendered on a device that has built-in support for the named device font, the should be rendered using a device specific mechanism for selecting that font, and by sending Unicode code points rather than glyph indices. When rendering onto a device that does not include built-in support for the named device font, should be ignored. + When a is rendered on a device that has built-in support for the named device font, the should be rendered using a device specific mechanism for selecting that font, and by sending Unicode code points rather than glyph indices. When rendering onto a device that does not include built-in support for the named device font, should be ignored. ## Dependency Property Information @@ -283,7 +283,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -435,7 +435,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -506,7 +506,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -592,7 +592,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -664,7 +664,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -810,7 +810,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -891,7 +891,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -962,7 +962,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -1102,7 +1102,7 @@ Various typographic qualities of two different glyph characters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> diff --git a/xml/System.Windows.Documents/Hyperlink.xml b/xml/System.Windows.Documents/Hyperlink.xml index b8bd3d095fa..e009258527f 100644 --- a/xml/System.Windows.Documents/Hyperlink.xml +++ b/xml/System.Windows.Documents/Hyperlink.xml @@ -657,7 +657,7 @@ . + This property overrides . ]]> @@ -710,7 +710,7 @@ When a user hovers the mouse over a in an XBAP, the URI stored in the property is displayed in the status bar. navigates to this URI when the user clicks the . If the value of the property changes after the user clicks the and before the subsequent navigation request, ignores the new value of the property and navigates to the URI that was the value of the property when the user clicked the . > [!NOTE] -> You are not restricted to only using a to do navigation. You can use the attached property as well, but only from the following: , , , and . +> You are not restricted to only using a to do navigation. You can use the attached property as well, but only from the following: , , , and . ## Dependency Property Information @@ -721,7 +721,7 @@ |Metadata properties set to `true`|None| ## Examples - The following example shows how to use the attribute of a element. + The following example shows how to use the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents/Hyperlink/Overview/Window1.xaml" id="Snippet_hyperlink_navurixaml"::: @@ -836,7 +836,7 @@ . + This method overrides . ]]> @@ -881,7 +881,7 @@ . + This method overrides . ]]> @@ -920,7 +920,7 @@ . + This method overrides . ]]> @@ -965,7 +965,7 @@ . + This method overrides . ]]> diff --git a/xml/System.Windows.Documents/Inline.xml b/xml/System.Windows.Documents/Inline.xml index ec0a8b646dd..976abe4b0f9 100644 --- a/xml/System.Windows.Documents/Inline.xml +++ b/xml/System.Windows.Documents/Inline.xml @@ -104,7 +104,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -181,12 +181,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextDecorations/Window1.xaml" id="Snippet_inline_flowdirectionxaml"::: @@ -410,12 +410,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextDecorations/Window1.xaml" id="Snippet_inline_textdecxaml"::: diff --git a/xml/System.Windows.Documents/Italic.xml b/xml/System.Windows.Documents/Italic.xml index 8df76e66c29..07e2ff9a57c 100644 --- a/xml/System.Windows.Documents/Italic.xml +++ b/xml/System.Windows.Documents/Italic.xml @@ -25,13 +25,13 @@ Provides an inline-level flow content element that causes content to render with an italic font style. - enforces a strong content model for child content. See [TextElement Content Model Overview](/dotnet/framework/wpf/advanced/textelement-content-model-overview) for more information about the content model. - - This is the equivalent of a with a value of and the two elements can be used interchangeably. - + enforces a strong content model for child content. See [TextElement Content Model Overview](/dotnet/framework/wpf/advanced/textelement-content-model-overview) for more information about the content model. + + This is the equivalent of a with a value of and the two elements can be used interchangeably. + ]]> @@ -109,14 +109,14 @@ The initial content of the new . Initializes a new instance of the class with the specified object as its initial content. - @@ -156,14 +156,14 @@ The insertion position at which to insert the element after it is created. Initializes a new instance of the class with the specified object as its initial content, and a that specifies an insertion position for the new element. - @@ -203,14 +203,14 @@ The end of a selection of content that the new will contain. Initializes a new instance of the class with the specified objects that indicate the beginning and end of a content selection that the new will contain. - diff --git a/xml/System.Windows.Documents/LinkTargetCollection.xml b/xml/System.Windows.Documents/LinkTargetCollection.xml index 35401dca5fe..df1bc8d52c3 100644 --- a/xml/System.Windows.Documents/LinkTargetCollection.xml +++ b/xml/System.Windows.Documents/LinkTargetCollection.xml @@ -24,11 +24,11 @@ Provides a collection of all of the elements in a . - elements in one collection, consuming applications can determine if a contains a particular link without having to load the entire . - + elements in one collection, consuming applications can determine if a contains a particular link without having to load the entire . + ]]> @@ -129,11 +129,11 @@ if is present; otherwise, . - method provides a quick means to test for a specified link. - + method provides a quick means to test for a specified link. + ]]> @@ -302,11 +302,11 @@ The link target to remove. Removes the first occurrence of a specific object from the . - diff --git a/xml/System.Windows.Documents/List.xml b/xml/System.Windows.Documents/List.xml index 6b29ff2ae5b..3d7bb85a678 100644 --- a/xml/System.Windows.Documents/List.xml +++ b/xml/System.Windows.Documents/List.xml @@ -277,7 +277,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -350,8 +350,8 @@ | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| -|Metadata properties set to `true`|, | +|Identifier field|| +|Metadata properties set to `true`|, | ]]> @@ -426,7 +426,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> diff --git a/xml/System.Windows.Documents/ListItem.xml b/xml/System.Windows.Documents/ListItem.xml index 75375028300..acd0a80ac92 100644 --- a/xml/System.Windows.Documents/ListItem.xml +++ b/xml/System.Windows.Documents/ListItem.xml @@ -224,12 +224,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -351,12 +351,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -445,12 +445,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_flowdirectionxaml"::: @@ -527,7 +527,7 @@ value does not change the height of the associated text; rather, it changes the height of the line that contains the text. + Changing the value does not change the height of the associated text; rather, it changes the height of the line that contains the text. In addition to this property, the layout of lines in a is affected by its property. @@ -567,12 +567,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_lineheightxaml"::: @@ -580,7 +580,7 @@ ![Screenshot: FlowDocument LineHeight](~/add/media/flowdocument-lineheight.png "Screenshot: FlowDocument LineHeight") - The following figure shows how the same example renders with the default setting of =. + The following figure shows how the same example renders with the default setting of =. ![Screenshot: FlowDocument LineHeight default](~/add/media/flowdocument-lineheightdefault.png "Screenshot: FlowDocument LineHeight default") @@ -658,12 +658,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -762,7 +762,7 @@ is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. + is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. Contrast with , which is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. ## XAML Attribute Usage @@ -809,12 +809,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -921,7 +921,7 @@ is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. + is buffer space that falls inside an element's content area, between the element's content and the inner edge of the element. Contrast with , which is buffer space that falls outside an element's content area, between the edges of the element's content area and the edges of the parent element. ## XAML Attribute Usage @@ -968,12 +968,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -1167,12 +1167,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_textalignmentxaml"::: diff --git a/xml/System.Windows.Documents/PageContent.xml b/xml/System.Windows.Documents/PageContent.xml index 75c1c66c9ee..8d28af834d7 100644 --- a/xml/System.Windows.Documents/PageContent.xml +++ b/xml/System.Windows.Documents/PageContent.xml @@ -44,7 +44,7 @@ provides information about the elements within a without the requiring the application to load individual pages. - The dependency property specifies the uniform resource identifier (URI) of the corresponding . + The dependency property specifies the uniform resource identifier (URI) of the corresponding . For more information about the element, see Chapter 3 of the XPS *Open XML Paper Specification* available for download at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). @@ -86,7 +86,7 @@ constructor. + The following example shows use of the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpfContent.cs" id="Snippetxpssavecreatefixedpage5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpfcontent.vb" id="Snippetxpssavecreatefixedpage5"::: @@ -147,9 +147,9 @@ The property returns a when: - has an immediate child defined in XAML markup. -- The has been called to set the as the child of the . +- The has been called to set the as the child of the . -The property returns **null** when the is set by the property (when specified by the property, the is not cached). Use or to return the when set by the property. +The property returns **null** when the is set by the property (when specified by the property, the is not cached). Use or to return the when set by the property. ## XAML Text Usage @@ -196,10 +196,10 @@ You cannot use this property in XAML. performs synchronous loading and parsing of the . + performs synchronous loading and parsing of the . > [!NOTE] -> Use the instead of to avoid thread blocking while the loads. +> Use the instead of to avoid thread blocking while the loads. ]]> @@ -239,13 +239,13 @@ You cannot use this property in XAML. asynchronously loads and parses the data stream associated with this . Other threads will continue to run while completes. + asynchronously loads and parses the data stream associated with this . Other threads will continue to run while completes. The following steps illustrate how to load the content asynchronously: 1. Create a delegate and add it to be notified of events. -2. Call . +2. Call . 3. When the event occurs and the delegate is called, the content has completed loading. The loaded element is returned through the . property. @@ -292,7 +292,7 @@ You cannot use this property in XAML. cancels any operation that has not already finished with a event. + cancels any operation that has not already finished with a event. ]]> @@ -373,7 +373,7 @@ You cannot use this property in XAML. will never return `null`, but the collection may contain zero elements. + will never return `null`, but the collection may contain zero elements. For more information about the `` element, see chapter 3 of the XPS specification which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). diff --git a/xml/System.Windows.Documents/PageContentCollection.xml b/xml/System.Windows.Documents/PageContentCollection.xml index ba4dac05cb3..70af07defcf 100644 --- a/xml/System.Windows.Documents/PageContentCollection.xml +++ b/xml/System.Windows.Documents/PageContentCollection.xml @@ -129,13 +129,13 @@ Returns an enumerator for iterating through the page collection. An enumerator that can be used to iterate through the collection. - . for other remarks about how enumerators should be used. - + . for other remarks about how enumerators should be used. + ]]> diff --git a/xml/System.Windows.Documents/Paragraph.xml b/xml/System.Windows.Documents/Paragraph.xml index 739f34c43fd..0d391311292 100644 --- a/xml/System.Windows.Documents/Paragraph.xml +++ b/xml/System.Windows.Documents/Paragraph.xml @@ -225,7 +225,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -300,7 +300,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -376,7 +376,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -452,7 +452,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -576,7 +576,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -702,7 +702,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> diff --git a/xml/System.Windows.Documents/Run.xml b/xml/System.Windows.Documents/Run.xml index 15eccecd93b..e78831b8925 100644 --- a/xml/System.Windows.Documents/Run.xml +++ b/xml/System.Windows.Documents/Run.xml @@ -255,7 +255,7 @@ ## Examples - The following example shows how to set the attribute of a element directly and by using binding. + The following example shows how to set the attribute of a element directly and by using binding. :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents/Run/Text/window1.xaml" id="Snippetbindablerun"::: diff --git a/xml/System.Windows.Documents/Table.xml b/xml/System.Windows.Documents/Table.xml index ea361accd2c..0f4ad06ac54 100644 --- a/xml/System.Windows.Documents/Table.xml +++ b/xml/System.Windows.Documents/Table.xml @@ -188,12 +188,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example defines a simple 2 x 3 table with a of 0.35 centimeters. + The following example defines a simple 2 x 3 table with a of 0.35 centimeters. :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkContentElement/ToolTip/Window1.xaml" id="Snippet_table_columnspacing"::: @@ -385,7 +385,7 @@ . + This method overrides . ]]> diff --git a/xml/System.Windows.Documents/TableCell.xml b/xml/System.Windows.Documents/TableCell.xml index 6752cdc9795..cec572c52d2 100644 --- a/xml/System.Windows.Documents/TableCell.xml +++ b/xml/System.Windows.Documents/TableCell.xml @@ -213,12 +213,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -342,12 +342,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_bordersxaml"::: @@ -432,7 +432,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -510,12 +510,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_flowdirectionxaml"::: @@ -638,12 +638,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_lineheightxaml"::: @@ -651,7 +651,7 @@ ![Screenshot: FlowDocument LineHeight](~/add/media/flowdocument-lineheight.png "Screenshot: FlowDocument LineHeight") - The following figure shows how the same example renders with the default setting of =. + The following figure shows how the same example renders with the default setting of =. ![Screenshot: FlowDocument LineHeight default](~/add/media/flowdocument-lineheightdefault.png "Screenshot: FlowDocument LineHeight default") @@ -730,12 +730,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of and the second has a value of . :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: @@ -806,7 +806,7 @@ . + This method overrides . ]]> @@ -890,12 +890,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute of a element (). + The following example shows how to set the attribute of a element (). :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_marginpaddingxaml"::: @@ -979,7 +979,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1053,12 +1053,12 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_textalignmentxaml"::: diff --git a/xml/System.Windows.Documents/TableCellCollection.xml b/xml/System.Windows.Documents/TableCellCollection.xml index 5cdfe3cae52..fac6a72d542 100644 --- a/xml/System.Windows.Documents/TableCellCollection.xml +++ b/xml/System.Windows.Documents/TableCellCollection.xml @@ -132,9 +132,9 @@ property represents the number of preallocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of preallocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is increased automatically to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalize with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is increased automatically to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalize with the current collection count. ]]> @@ -174,7 +174,7 @@ , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. + After calling , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. ]]> @@ -340,9 +340,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is increased automatically to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalize with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is increased automatically to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalize with the current collection count. ]]> @@ -423,7 +423,7 @@ equals for this collection, the collection capacity is increased automatically before the new item is inserted. Set `index` equal to the value of to append a new collection item to the collection. + If equals for this collection, the collection capacity is increased automatically before the new item is inserted. Set `index` equal to the value of to append a new collection item to the collection. Indices for existing collection items might be adjusted to accommodate the newly inserted collection item. @@ -745,7 +745,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -828,7 +828,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -873,7 +873,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -917,7 +917,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -960,7 +960,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1004,7 +1004,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1169,7 +1169,7 @@ instance is cast to an interface. Use the type safe , , or methods instead + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type safe , , or methods instead ]]> @@ -1211,7 +1211,7 @@ instance is cast to an interface. Use the type safe , , or methods instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type safe , , or methods instead. ]]> diff --git a/xml/System.Windows.Documents/TableColumn.xml b/xml/System.Windows.Documents/TableColumn.xml index c869d729eaa..0c6459d31c5 100644 --- a/xml/System.Windows.Documents/TableColumn.xml +++ b/xml/System.Windows.Documents/TableColumn.xml @@ -88,7 +88,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | ]]> @@ -159,7 +159,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Documents/TableColumnCollection.xml b/xml/System.Windows.Documents/TableColumnCollection.xml index b50d5da15f1..2865cee1196 100644 --- a/xml/System.Windows.Documents/TableColumnCollection.xml +++ b/xml/System.Windows.Documents/TableColumnCollection.xml @@ -132,9 +132,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -175,7 +175,7 @@ , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. + After calling , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. ]]> @@ -341,9 +341,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -424,7 +424,7 @@ equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set `index` equal to the value of , to append a new collection item to the collection. + If equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set `index` equal to the value of , to append a new collection item to the collection. Indices for existing collection items may be adjusted to accommodate the newly inserted collection item. @@ -746,7 +746,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Documents/TableRowCollection.xml b/xml/System.Windows.Documents/TableRowCollection.xml index 9887e1a9a67..81d1bcfba6b 100644 --- a/xml/System.Windows.Documents/TableRowCollection.xml +++ b/xml/System.Windows.Documents/TableRowCollection.xml @@ -132,9 +132,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -175,7 +175,7 @@ , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. + After calling , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. ]]> @@ -341,9 +341,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -424,7 +424,7 @@ equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set *index* equal to the value of , to append a new collection item to the collection. + If equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set *index* equal to the value of , to append a new collection item to the collection. Indices for existing collection items may be adjusted to accommodate the newly inserted collection item. @@ -746,7 +746,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -829,7 +829,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -874,7 +874,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -918,7 +918,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -961,7 +961,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1005,7 +1005,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1170,7 +1170,7 @@ instance is cast to an interface. Use the type-safe , , or methods instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe , , or methods instead. ]]> @@ -1212,7 +1212,7 @@ instance is cast to an interface. Use the type-safe , , or methods instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe , , or methods instead. ]]> diff --git a/xml/System.Windows.Documents/TableRowGroupCollection.xml b/xml/System.Windows.Documents/TableRowGroupCollection.xml index 823fc809a6d..02926d3e3d5 100644 --- a/xml/System.Windows.Documents/TableRowGroupCollection.xml +++ b/xml/System.Windows.Documents/TableRowGroupCollection.xml @@ -132,9 +132,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -175,7 +175,7 @@ , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. + After calling , the value of the property becomes **0** and the value of the property is unchanged. To set a new capacity, call or explicitly set a new capacity through the property. ]]> @@ -341,9 +341,9 @@ property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . + The property represents the number of pre-allocated slots for storing items in this collection, whereas the property represents the actual number of items currently in the collection. The value of is always at least as large as the value of . - When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. + When newly added collection items cause the collection count to exceed the collection capacity, the capacity is automatically increased to accommodate the newly added collection items. Increasing the collection capacity involves allocating additional collection slots, which incurs both performance and memory overhead. Use the property to optimize the collection capacity in cases where the total or maximum number of collection items is known in advance. Use the method to cause the collection capacity to equalized with the current collection count. ]]> @@ -424,7 +424,7 @@ equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set *index* equal to the value of , to append a new collection item to the collection. + If equals for this collection, the collection capacity automatically is increased before the new item is inserted. Set *index* equal to the value of , to append a new collection item to the collection. Indices for existing collection items may be adjusted to accommodate the newly inserted collection item. @@ -746,7 +746,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -829,7 +829,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -874,7 +874,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -918,7 +918,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -961,7 +961,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1005,7 +1005,7 @@ instance is cast to an interface. Use the type-safe method instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe method instead. ]]> @@ -1170,7 +1170,7 @@ instance is cast to an interface. Use the type-safe , , or methods instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe , , or methods instead. ]]> @@ -1212,7 +1212,7 @@ instance is cast to an interface. Use the type-safe , , or methods instead. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. Use the type-safe , , or methods instead. ]]> diff --git a/xml/System.Windows.Documents/TextElement.xml b/xml/System.Windows.Documents/TextElement.xml index b7b4685474b..3dfab5de6bb 100644 --- a/xml/System.Windows.Documents/TextElement.xml +++ b/xml/System.Windows.Documents/TextElement.xml @@ -69,10 +69,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_backgroundxaml"::: @@ -150,7 +150,7 @@ ## Remarks The property is often used to append content to the end of a . - The returned by this property always has its set to . + The returned by this property always has its set to . ]]> @@ -191,7 +191,7 @@ ## Remarks The property is often used to insert content to the beginning of a . - The returned by this property always has its set to . + The returned by this property always has its set to . ]]> @@ -230,7 +230,7 @@ returned by this property always has its set to . + The returned by this property always has its set to . ]]> @@ -269,7 +269,7 @@ returned by this property always has its set to . + The returned by this property always has its set to . ]]> @@ -316,9 +316,9 @@ ## Remarks When multiple families are specified, the second and subsequent font families serve as fallback families to be used in cases where the primary font family is unavailable or not applicable. - This property specifies a preference only. If the specified font family is not available, the silently falls back to the font determined by the value. + This property specifies a preference only. If the specified font family is not available, the silently falls back to the font determined by the value. - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontFamily` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontFamily` property, which the content host uses for rendering. ## XAML Attribute Usage @@ -353,10 +353,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_fontpropsxaml"::: @@ -441,7 +441,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontSize` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontSize` property, which the content host uses for rendering. ## XAML Attribute Usage @@ -476,10 +476,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_fontpropsxaml"::: @@ -556,7 +556,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names of the class. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStretch` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names of the class. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStretch` property, which the content host uses for rendering. ## Dependency Property Information @@ -564,10 +564,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_fontpropsxaml"::: @@ -642,7 +642,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names in the class. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStyle` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format property names in the class. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontStyle` property, which the content host uses for rendering. ## Dependency Property Information @@ -650,10 +650,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_fontpropsxaml"::: @@ -728,7 +728,7 @@ `, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values of the enumeration. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontWeight` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is one of the string-format values of the enumeration. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `FontWeight` property, which the content host uses for rendering. ## Dependency Property Information @@ -736,10 +736,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_fontpropsxaml"::: @@ -816,7 +816,7 @@ ## Remarks For a table of swatches that shows the available predefined brush colors, see . - This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string that resolves to a implementation value. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `Foreground` property, which the content host uses for rendering. + This dependency property also has an attached property usage. In XAML, the usage is ``, where *object* is an object element (typically a flow element) contained within a , and *value* is a string that resolves to a implementation value. In code, the attached property usage is supported by the and methods. The attached property usage is not common, because most elements that can be contained in a support an analogous nonattached `Foreground` property, which the content host uses for rendering. ## Dependency Property Information @@ -824,10 +824,10 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_backgroundxaml"::: @@ -1157,7 +1157,7 @@ . + This method overrides . ]]> @@ -1493,7 +1493,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples The following example shows how to create a simple text effect and apply it to a text through the property. @@ -1566,7 +1566,7 @@ The property is applicable only to OpenType fonts. A typography variant has no effect on fonts that do not support the variant. For more information on this topic, see [Typography in WPF](/dotnet/framework/wpf/advanced/typography-in-wpf). ## Examples - The following example shows how to set the attribute, using as the example element. + The following example shows how to set the attribute, using as the example element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Controls/TextBlock/TextEffects/Window1.xaml" id="Snippet_textelement_typogxaml"::: diff --git a/xml/System.Windows.Documents/TextElementEditingBehaviorAttribute.xml b/xml/System.Windows.Documents/TextElementEditingBehaviorAttribute.xml index 5fcc53f1c24..3d1e77e215c 100644 --- a/xml/System.Windows.Documents/TextElementEditingBehaviorAttribute.xml +++ b/xml/System.Windows.Documents/TextElementEditingBehaviorAttribute.xml @@ -33,7 +33,7 @@ attribute to specify that the element should be treated as a single, unbreakable entity. When the and properties are set to `false`, a preserves the boundaries and content of the element when the user edits the . In general, the custom element behaves similar to a . The following behavior occurs when you use this class and set both of its properties to `false`: + When you create a custom text element, you can use the attribute to specify that the element should be treated as a single, unbreakable entity. When the and properties are set to `false`, a preserves the boundaries and content of the element when the user edits the . In general, the custom element behaves similar to a . The following behavior occurs when you use this class and set both of its properties to `false`: - When a user copies and pastes a part of the content in a custom element, the formatting of the copied text is not preserved. @@ -41,7 +41,7 @@ - The user cannot insert a line break in the custom element. - When you create a custom element, use the method and set `preserveTextElements` to `true` to preserve the custom element and property values when you serialize it to the disk or clipboard. + When you create a custom element, use the method and set `preserveTextElements` to `true` to preserve the custom element and property values when you serialize it to the disk or clipboard. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -128,7 +128,7 @@ is `true`, the decision to combine adjacent text elements that have identical property values is left up to the . When is `false`, a does not combine two adjacent text elements. + When is `true`, the decision to combine adjacent text elements that have identical property values is left up to the . When is `false`, a does not combine two adjacent text elements. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -177,7 +177,7 @@ is `true` and the user copies and pastes part of the content of a custom text element, the formatting is preserved. When is `false`, the formatting is preserved only if the user copies and pastes all of the content of the custom text element. + When is `true` and the user copies and pastes part of the content of a custom text element, the formatting is preserved. When is `false`, the formatting is preserved only if the user copies and pastes all of the content of the custom text element. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). diff --git a/xml/System.Windows.Documents/TextPointer.xml b/xml/System.Windows.Documents/TextPointer.xml index a266fe6c3fb..be4b59a7a65 100644 --- a/xml/System.Windows.Documents/TextPointer.xml +++ b/xml/System.Windows.Documents/TextPointer.xml @@ -45,43 +45,43 @@ - Text Container - A *text container* is the element that forms the ultimate border for the flow content at hand; the position indicated by a always falls within a text container. Currently, a text container must be either a or a . Generally speaking, operations between instances in different text containers are not supported. -- Document - The content in a text container is referred to as a *document*, as in the method and the and properties. +- Document - The content in a text container is referred to as a *document*, as in the method and the and properties. The class is intended to facilitate traversal and manipulation of content that is represented by Windows Presentation Foundation (WPF) flow content elements; in general, such elements derive from . Some of the operations that facilitates include the following: -- Perform an ordinal comparison of the current position with a second specified position. See the method. +- Perform an ordinal comparison of the current position with a second specified position. See the method. -- Determine the type of content adjacent to the current position in a specified direction. See the method and enumeration. +- Determine the type of content adjacent to the current position in a specified direction. See the method and enumeration. -- Get the that scopes or is adjacent to the current position. See and the method. +- Get the that scopes or is adjacent to the current position. See and the method. - Get the text container that scopes the current document. See the property. -- Get a specified number of characters preceding or following the current position. See the method. +- Get a specified number of characters preceding or following the current position. See the method. -- Insert a string of characters at the current position. See the method. +- Insert a string of characters at the current position. See the method. -- Find line boundaries in content. See the method and property. +- Find line boundaries in content. See the method and property. -- Translate between positions and symbol offsets into content. See the and methods. +- Translate between positions and symbol offsets into content. See the and methods. - Perform visual hit testing by translating between a position and a representing relative coordinates. -- Find a nearby insertion position, or check whether the current position is an insertion position. See the and methods and the property. +- Find a nearby insertion position, or check whether the current position is an insertion position. See the and methods and the property. - The position and indicated by a object are immutable. When content is edited or modified, the position indicated by a does not change relative to the surrounding text; rather the offset of that position from the beginning of content is adjusted correspondingly to reflect the new relative position in content. For example, a that indicates a position at the beginning of a given paragraph continues to point to the beginning of that paragraph even when content is inserted or deleted before or after the paragraph. + The position and indicated by a object are immutable. When content is edited or modified, the position indicated by a does not change relative to the surrounding text; rather the offset of that position from the beginning of content is adjusted correspondingly to reflect the new relative position in content. For example, a that indicates a position at the beginning of a given paragraph continues to point to the beginning of that paragraph even when content is inserted or deleted before or after the paragraph. The class does not provide any public constructors. An instance of is created by using properties or methods of other objects (including other objects). The following list provides a few examples of methods and properties that create and return a . This list is not exhaustive: -- From a : and . +- From a : and . -- From a : , , , and . +- From a : , , , and . -- From a (text container): , , and . +- From a (text container): , , and . -- From a (text container): , and +- From a (text container): , and -- From an existing : , , , and . +- From an existing : , , , and . @@ -142,7 +142,7 @@ ## Examples - The following example demonstrates a use for this method. In the example, the method is used in conjunction with the method to test whether a specified is empty. + The following example demonstrates a use for this method. In the example, the method is used in conjunction with the method to test whether a specified is empty. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getinsertionposition"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getinsertionposition"::: @@ -229,7 +229,7 @@ for the returned is always a text container ( or ), rather than a . + The for the returned is always a text container ( or ), rather than a . ]]> @@ -266,9 +266,9 @@ and methods provide a way to translate between positions and position offsets. + Use the position returned by this property as a baseline position from which to work with relative offsets to other positions. The and methods provide a way to translate between positions and position offsets. - The for the returned is always a text container ( or ), rather than a . + The for the returned is always a text container ( or ), rather than a . ]]> @@ -395,7 +395,7 @@ ## Remarks An insertion position is a position where new content may be added without breaking any semantic rules for the associated content. In practice, an insertion position is anywhere in content where a caret may be positioned. An example of a valid position that is not an insertion position is the position between two adjacent tags (that is, between the closing tag of the preceding paragraph and the opening tag of the next paragraph). - If the already points to a valid insertion position, but the closing tag for a non-empty formatting sequence directly follows that position in the given direction, then the returned by this method is adjusted to point to the insertion position just after the close of the formatting sequence. For example, consider the markup sequence `ab`. Note that there are two insertion positions between the letters `a` and `b` - one that precedes the closing `Bold` tag, and one directly following the closing `Bold` tag. If is called on a to the position directly after the letter `a` and before of the closing `Bold` tag, and with a `direction` of , the returned is adjusted to point to the position just before the letter `b`, after the closing `Bold` tag. A similar adjustment is made for opening formatting tags when working in the opposite logical direction. This method is intended to provide a means of disambiguation between insertion positions in similar cases. + If the already points to a valid insertion position, but the closing tag for a non-empty formatting sequence directly follows that position in the given direction, then the returned by this method is adjusted to point to the insertion position just after the close of the formatting sequence. For example, consider the markup sequence `ab`. Note that there are two insertion positions between the letters `a` and `b` - one that precedes the closing `Bold` tag, and one directly following the closing `Bold` tag. If is called on a to the position directly after the letter `a` and before of the closing `Bold` tag, and with a `direction` of , the returned is adjusted to point to the position just before the letter `b`, after the closing `Bold` tag. A similar adjustment is made for opening formatting tags when working in the opposite logical direction. This method is intended to provide a means of disambiguation between insertion positions in similar cases. This method can also be used to be selective about insertion points when a sequence of structural tags is involved. For example, when at a position between closing and opening paragraph tags, the direction parameter can be used to select the closest insertion point at the beginning of the following paragraph (by specifying ) or at the end of the preceding paragraph (by specifying ). @@ -406,7 +406,7 @@ ## Examples - This example shows how to use the method to check whether a specified is empty of printable content. + This example shows how to use the method to check whether a specified is empty of printable content. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getinsertionposition"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getinsertionposition"::: @@ -459,9 +459,9 @@ points to an ambiguous position, for example, between two lines, the line in the direction specified by is selected as the relative starting line. + If the points to an ambiguous position, for example, between two lines, the line in the direction specified by is selected as the relative starting line. - The operation performed by this method depends on a valid layout. When necessary, this method attempts to automatically regenerate a valid layout before proceeding with the operation. Regenerating a layout can be a relatively expensive operation. Use to check for a valid layout before performing operations that may regenerate the layout. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). + The operation performed by this method depends on a valid layout. When necessary, this method attempts to automatically regenerate a valid layout before proceeding with the operation. Regenerating a layout can be a relatively expensive operation. Use to check for a valid layout before performing operations that may regenerate the layout. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). ]]> @@ -551,14 +551,14 @@ - A 16-bit Unicode character inside of a text element. - If the next symbol is categorized as , , or (as identified by the method), then the returned by this method is advanced by exactly one symbol from the current position. + If the next symbol is categorized as , , or (as identified by the method), then the returned by this method is advanced by exactly one symbol from the current position. - If the next symbol is categorized as , then the returned by this method is advanced past the text to the next non-text symbol (that is, the next position where the is not ). The exact symbol count crossed can be calculated in advance by calling the method. + If the next symbol is categorized as , then the returned by this method is advanced past the text to the next non-text symbol (that is, the next position where the is not ). The exact symbol count crossed can be calculated in advance by calling the method. ## Examples - The following example demonstrates a use for this method. The example uses the method in conjunction with the method to traverse and extract the symbols in a specified . + The following example demonstrates a use for this method. The example uses the method in conjunction with the method to traverse and extract the symbols in a specified . While the example can be used to extract a XAML structure for the contents of a given , it is intended for illustrative purposes only, and should not be used in production code. See the namespace for a rich set of types designed for working with and processing XML. @@ -608,7 +608,7 @@ ## Examples - The following example demonstrates a use for this method. The example uses the method to traverse content element boundaries in order to count the number of elements present between two specified instances. + The following example demonstrates a use for this method. The example uses the method to traverse content element boundaries in order to count the number of elements present between two specified instances. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getnextinsertionposition"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getnextinsertionposition"::: @@ -663,7 +663,7 @@ ## Examples - The following example demonstrates a use for this method. The example uses the method to find the offsets for two instances, and then uses this information to save and restore the selection in a . The example assumes that the contents of the have not changed between a selection save and a selection restore. + The following example demonstrates a use for this method. The example uses the method to find the offsets for two instances, and then uses this information to save and restore the selection in a . The example assumes that the contents of the have not changed between a selection save and a selection restore. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getoffsettoposition"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getoffsettoposition"::: @@ -710,7 +710,7 @@ method to implement an algorithm for calculating the balance of opening and closing element tags between two specified positions. Each opening element tag is counted as +1, and each closing element tag is counted as -1. + The following example demonstrates a use for this method. The example uses the method to implement an algorithm for calculating the balance of opening and closing element tags between two specified positions. Each opening element tag is counted as +1, and each closing element tag is counted as -1. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getoffsettoposition2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getoffsettoposition2"::: @@ -773,7 +773,7 @@ ## Examples - The following example demonstrates a use for this method. The example uses the method to implement a pair of methods, one to calculate the offset to a specified position relative to any hosting paragraph, and the other to return a to a specified offset in a specified paragraph. + The following example demonstrates a use for this method. The example uses the method to implement a pair of methods, one to calculate the offset to a specified position relative to any hosting paragraph, and the other to return a to a specified offset in a specified paragraph. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_getpositionatoffset"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_getpositionatoffset"::: @@ -880,7 +880,7 @@ ## Examples - The following example demonstrates a use for this method. The example uses the method to implement a simple text extractor. The method returns a string concatenation of all text between two specified instances. + The following example demonstrates a use for this method. The example uses the method to implement a simple text extractor. The method returns a string concatenation of all text between two specified instances. While the example can be used to extract any text between two instances, it is intended for illustrative purposes only, and should not be used in production code. Use the property instead. @@ -1024,7 +1024,7 @@ method, method, and property) attempt to automatically regenerate a valid layout before proceeding with the operation. Regenerating a layout can be a relatively expensive operation. Use this property to check for a valid layout before performing operations that may regenerate the layout. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). + When necessary, operations that depend on a valid layout (such as the method, method, and property) attempt to automatically regenerate a valid layout before proceeding with the operation. Regenerating a layout can be a relatively expensive operation. Use this property to check for a valid layout before performing operations that may regenerate the layout. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). ]]> @@ -1254,12 +1254,12 @@ instances are only valid if the instances in question indicate positions that are in the same text container scope. For example the and methods cannot be used with a to a position outside of the text container associated with the current position. Use this method to verify that a specified is compatible with the current position for such operations. + Most operations that involve multiple instances are only valid if the instances in question indicate positions that are in the same text container scope. For example the and methods cannot be used with a to a position outside of the text container associated with the current position. Use this method to verify that a specified is compatible with the current position for such operations. ## Examples - The following example demonstrates a use for this method. The example uses the method to check whether a specified is positioned between two other specified instances in a situation when there is no guarantee that all three positions belong to the same text container. + The following example demonstrates a use for this method. The example uses the method to check whether a specified is positioned between two other specified instances in a situation when there is no guarantee that all three positions belong to the same text container. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textpointer_isinsamedocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textpointer_isinsamedocument"::: diff --git a/xml/System.Windows.Documents/TextRange.xml b/xml/System.Windows.Documents/TextRange.xml index 3e0139aeb7a..335ea4ff0c9 100644 --- a/xml/System.Windows.Documents/TextRange.xml +++ b/xml/System.Windows.Documents/TextRange.xml @@ -154,7 +154,7 @@ ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_loadsave"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_loadsave"::: @@ -202,12 +202,12 @@ method to actually load content into the current selection in a specified data format. + Use the corresponding method to actually load content into the current selection in a specified data format. ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_loadsave"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_loadsave"::: @@ -253,12 +253,12 @@ method to actually save the current selection in a specified data format. + Use the corresponding method to actually save the current selection in a specified data format. ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_loadsave"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_loadsave"::: @@ -370,12 +370,12 @@ and ) are considered to be part of the current selection. + Positions at either end of the current selection (indicated by and ) are considered to be part of the current selection. ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_startend"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_startend"::: @@ -500,7 +500,7 @@ is considered empty if the and positions are equal. + A is considered empty if the and positions are equal. @@ -555,14 +555,14 @@ is `true` for `stream`, content will be loaded from the beginning of the stream to the end of the stream. Otherwise, content will be read from the current to the end of the stream. When this method returns, `stream` is left open, and the current position within `stream` is undefined. + If is `true` for `stream`, content will be loaded from the beginning of the stream to the end of the stream. Otherwise, content will be read from the current to the end of the stream. When this method returns, `stream` is left open, and the current position within `stream` is undefined. A load operation replaces the current selection with the newly loaded content. ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_loadsave"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_loadsave"::: @@ -627,7 +627,7 @@ ## Examples - The following example demonstrates the use of the method. + The following example demonstrates the use of the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippet_textrange_loadsave"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippet_textrange_loadsave"::: @@ -686,7 +686,7 @@ ## Remarks When `preserveTextElements` is `false`, custom objects are saved as known types. For example, suppose you create a custom called `Heading1`, which inherits from . When you call this method with `preserveTextElements` set to `false`, `Heading1` is converted to a when the is saved. When you call this method with `preserveTextElements` set to `true`, `Heading1` is saved without being converted. To preserve custom text elements, `dataFormat` must be set to . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Documents/Typography.xml b/xml/System.Windows.Documents/Typography.xml index 0be78186dc7..101a0692f25 100644 --- a/xml/System.Windows.Documents/Typography.xml +++ b/xml/System.Windows.Documents/Typography.xml @@ -49,49 +49,49 @@ Text using OpenType capitals |Property|Value(s)|Default Value| |--------------|----------------|-------------------| -||Numeric value - byte|0| -|| | | | | | | |.| -|||`false`| -|||`false`| -|||`true`| -|||`true`| -||Numeric value - byte|0| -|||`false`| -|||`false`| -|| | | | | | | | | | |.| -|| | | | | | |.| -|| | | |.| -|||`false`| -|||`false`| -|||`true`| -|||`false`| -|| | | |.| -|||.| -|||`false`| -|||`true`| -||numeric value - byte|0| -||numeric value - byte|0| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|||`false`| -|| | | | | | |.| +||Numeric value - byte|0| +|| | | | | | | |.| +|||`false`| +|||`false`| +|||`true`| +|||`true`| +||Numeric value - byte|0| +|||`false`| +|||`false`| +|| | | | | | | | | | |.| +|| | | | | | |.| +|| | | |.| +|||`false`| +|||`false`| +|||`true`| +|||`false`| +|| | | |.| +|||.| +|||`false`| +|||`true`| +||numeric value - byte|0| +||numeric value - byte|0| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|||`false`| +|| | | | | | |.| All dependency properties of this class also have an attached property usage in XAML. For instance, you can set the property through this syntax: @@ -101,11 +101,11 @@ Text using OpenType capitals ## Examples - The following code sample shows the use typographic in XAML. Notice that the variant feature is applied to all text contained with the element. + The following code sample shows the use typographic in XAML. Notice that the variant feature is applied to all text contained with the element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents/Typography/Overview/PageTwo.xaml" id="Snippettypographysnippet2"::: - The following code sample shows the use typographic and features in XAML. Notice that both typographic properties are applied to the entire paragraph. + The following code sample shows the use typographic and features in XAML. Notice that both typographic properties are applied to the entire paragraph. :::code language="xaml" source="~/snippets/csharp/System.Windows.Documents/Typography/Overview/PageThree.xaml" id="Snippettypographysnippet3"::: @@ -145,7 +145,7 @@ Text using OpenType capitals ## Remarks Annotation forms include glyphs placed in open or solid circles, squares, parentheses, diamonds or rounded boxes. - If the value of is greater than zero and the selected font does not support annotation alternates, the default form of the letter is displayed. + If the value of is greater than zero and the selected font does not support annotation alternates, the default form of the letter is displayed. This property gets or sets a value on the object that owns a `Typography` property, which is the only way to access a class instance. In addition, this property supports an attached property usage so that it can be set on text-containing objects in XAML. @@ -159,7 +159,7 @@ Text using OpenType capitals | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -251,7 +251,7 @@ Example of capitals | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -310,7 +310,7 @@ Example of normal and capital spacing | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -416,7 +416,7 @@ Example of normal and capital spacing | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -502,7 +502,7 @@ Example of random contextual alternates | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -572,7 +572,7 @@ Example of random contextual alternates Contextual ligatures are designed to enhance readability by providing better joining behavior between the characters that make up the ligature. - If the value of is `true` and the selected font does not support contextual ligatures, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support contextual ligatures, the default form of the letter is displayed. ## XAML Attribute Usage @@ -584,7 +584,7 @@ Example of random contextual alternates | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -672,7 +672,7 @@ Example of a contextual swash | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -759,7 +759,7 @@ Example of discretionary set of ligatures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -839,7 +839,7 @@ Example of discretionary set of ligatures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -917,7 +917,7 @@ Example of discretionary set of ligatures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -995,7 +995,7 @@ Example of discretionary set of ligatures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -1084,7 +1084,7 @@ Example of slashed and stacked fraction styles | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -2891,7 +2891,7 @@ Example of historical forms | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -2971,7 +2971,7 @@ Example of historical forms | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -3054,7 +3054,7 @@ Example of historical forms | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -3121,7 +3121,7 @@ Example of historical forms ## Remarks This property gets or sets a value on the object that owns a `Typography` property, which is the only way to access a class instance. In addition, this property supports an attached property usage so that it can be set on text-containing objects in XAML. - If the value of is `true` and the selected font does not support mathematical Greek forms, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support mathematical Greek forms, the default form of the letter is displayed. ## XAML Attribute Usage @@ -3133,7 +3133,7 @@ Example of historical forms | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -3220,7 +3220,7 @@ Example of proportional and tabbed figures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -3312,7 +3312,7 @@ Example of standard and old style numeral sets | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -4940,7 +4940,7 @@ Example of slashed zero numerals :::code language="xaml" source="~/snippets/csharp/System.Windows/FontCapitals/Overview/PageOne.xaml" id="Snippetopentypefontsnippet15"::: - If the value of is `true` and the selected font does not support slashed zero forms, the default form of the numeral is displayed. + If the value of is `true` and the selected font does not support slashed zero forms, the default form of the numeral is displayed. ## XAML Attribute Usage @@ -4952,7 +4952,7 @@ Example of slashed zero numerals | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5044,7 +5044,7 @@ Example of disabled standard ligatures :::code language="xaml" source="~/snippets/csharp/System.Windows/FontCapitals/Overview/PageOne.xaml" id="Snippet6"::: - If the value of is `true` and the selected font does not support standard ligatures, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support standard ligatures, the default form of the letter is displayed. ## XAML Attribute Usage @@ -5056,7 +5056,7 @@ Example of disabled standard ligatures | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5139,7 +5139,7 @@ Example of swashes used for capital letters :::code language="xaml" source="~/snippets/csharp/System.Windows/FontCapitals/Overview/PageOne.xaml" id="Snippet7"::: - If the value of is greater than zero and the selected font does not support standard swashes forms at the given index value, the default form of the letter is displayed. + If the value of is greater than zero and the selected font does not support standard swashes forms at the given index value, the default form of the letter is displayed. ## XAML Attribute Usage @@ -5151,7 +5151,7 @@ Example of swashes used for capital letters | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5251,7 +5251,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5331,7 +5331,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5382,7 +5382,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5461,7 +5461,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5540,7 +5540,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5619,7 +5619,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5698,7 +5698,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5777,7 +5777,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5856,7 +5856,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -5935,7 +5935,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6014,7 +6014,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6093,7 +6093,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6200,7 +6200,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6251,7 +6251,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6358,7 +6358,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6437,7 +6437,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6516,7 +6516,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6595,7 +6595,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6672,7 +6672,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6751,7 +6751,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6830,7 +6830,7 @@ Example of other stylistic alternate glyphs | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -6928,7 +6928,7 @@ Example of subscripts | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> diff --git a/xml/System.Windows.Documents/ZoomPercentageConverter.xml b/xml/System.Windows.Documents/ZoomPercentageConverter.xml index 380cc03bae7..f0ee4794f7e 100644 --- a/xml/System.Windows.Documents/ZoomPercentageConverter.xml +++ b/xml/System.Windows.Documents/ZoomPercentageConverter.xml @@ -101,19 +101,19 @@ The language and culture assumed during the conversion. Converts the (used as the value of ) to an object of the specified type. - when the converter cannot produce a value; for example, when is or when is not or . - + when the converter cannot produce a value; for example, when is or when is not or . + -or- - + The new of the designated type. As implemented in this class, this must be either a or a . If it is a string, it will be formatted appropriately for the . - may be returned to indicate that the converter produced no value and that the fallback (if available) or default value should be used instead. - - Pass `null` for `parameter`. This parameter is required by the signature of , and is used by some implementations to provide contextual information to the converter; but it is not used in this class. - + may be returned to indicate that the converter produced no value and that the fallback (if available) or default value should be used instead. + + Pass `null` for `parameter`. This parameter is required by the signature of , and is used by some implementations to provide contextual information to the converter; but it is not used in this class. + ]]> @@ -158,21 +158,21 @@ The language and culture assumed during the conversion. Returns a previously converted value of back to a that can be assigned to . - when the converter cannot produce a value; for example, when is not a valid percentage when is not or . - + when the converter cannot produce a value; for example, when is not a valid percentage when is not or . + -or- - + A representing the zoom percentage of a . - may be returned to indicate that the converter produced no value and that the fallback (if available) or default value should be used instead. - - Pass `null` for `parameter`. This parameter is required by the signature of , and is used by some implementations to provide contextual information to the converter; but it is not used in this class. - + may be returned to indicate that the converter produced no value and that the fallback (if available) or default value should be used instead. + + Pass `null` for `parameter`. This parameter is required by the signature of , and is used by some implementations to provide contextual information to the converter; but it is not used in this class. + ]]> diff --git a/xml/System.Windows.Forms/TableLayoutSettings.xml b/xml/System.Windows.Forms/TableLayoutSettings.xml index 24b690550d8..fad9358b647 100644 --- a/xml/System.Windows.Forms/TableLayoutSettings.xml +++ b/xml/System.Windows.Forms/TableLayoutSettings.xml @@ -416,7 +416,7 @@ ]]> .NET Framework only: The property value is not valid for the enumeration type. - .NET 5 and earlier versions only: The property value is not valid for the enumeration type. + .NET Framework only: The property value is not valid for the enumeration type. .NET 6 and later versions only: The property value is not valid for the enumeration type. diff --git a/xml/System.Windows.Ink/DrawingAttributes.xml b/xml/System.Windows.Ink/DrawingAttributes.xml index 7c2fb7e6d8b..e2e5f4ddb35 100644 --- a/xml/System.Windows.Ink/DrawingAttributes.xml +++ b/xml/System.Windows.Ink/DrawingAttributes.xml @@ -33,7 +33,7 @@ ## Remarks Use the property to specify settings such as color, width, transparency, and the shape of the stylus tip for a . - Use the property to specify the drawing attributes for the strokes added to an . Only strokes that are added after the undergo change show the updated attributes. The appearance of the strokes that are already on the does not change. + Use the property to specify the drawing attributes for the strokes added to an . Only strokes that are added after the undergo change show the updated attributes. The appearance of the strokes that are already on the does not change. For a list of initial property values for an instance of the class, see the constructor. @@ -83,14 +83,14 @@ |Property|Initial Value| |--------------|-------------------| -||Black| -||`false`| -||2 device independent pixels (DIP)| -||`false`| -||`false`| -||| -||| -||2 DIP| +||Black| +||`false`| +||2 device independent pixels (DIP)| +||`false`| +||`false`| +||| +||| +||2 DIP| ]]> @@ -131,7 +131,7 @@ method enables you to add custom properties to a object. This is useful when you render your own strokes and want to provide extra information. + The method enables you to add custom properties to a object. This is useful when you render your own strokes and want to provide extra information. @@ -223,7 +223,7 @@ method creates a new object and populates it with the same values as the current object. Any custom properties are also copied. + The method creates a new object and populates it with the same values as the current object. Any custom properties are also copied. @@ -366,29 +366,29 @@ ## Remarks Two objects are equal if the following properties are equal: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- > [!NOTE] -> The method does not check the custom properties for equality. +> The method does not check the custom properties for equality. ## Examples - The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.vb" id="Snippet10"::: @@ -519,7 +519,7 @@ method to access custom properties you added to a object. returns the default value for the built-in property if a value has not been set. + Use the method to access custom properties you added to a object. returns the default value for the built-in property if a value has not been set. @@ -941,7 +941,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -1019,7 +1019,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event. ]]> @@ -1069,29 +1069,29 @@ ## Remarks Two objects are equal if the following properties are equal: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- > [!NOTE] -> The method does not check the custom properties for equality. +> The method does not check the custom properties for equality. - The equivalent method for this operator is . + The equivalent method for this operator is . ## Examples - The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + The following example compares two objects for equality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.vb" id="Snippet10"::: @@ -1141,29 +1141,29 @@ ## Remarks Two objects are not equal if the following properties are not equal: -- +- -- +- -- +- -- +- -- +- -- +- -- +- -- +- > [!NOTE] -> The method does not check the custom properties for equality. +> The method does not check the custom properties for equality. - The equivalent method for this operator is the negation of . + The equivalent method for this operator is the negation of . ## Examples - The following example compares two objects for inequality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. + The following example compares two objects for inequality. Because the , , , and properties on `attributes1` and `attributes2` are set to the same values, the "The DrawingAttributes are equal" message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkCanvas/Overview/Window1.xaml.vb" id="Snippet10"::: @@ -1204,7 +1204,7 @@ . When the `Shadowed` property changes, the event handler calls the method, which causes the stroke to be redrawn. + The following example is part of a custom stroke that can draw a three-dimensional effect. The stroke defines and stores a custom property called `Shadowed`, which belongs to . When the `Shadowed` property changes, the event handler calls the method, which causes the stroke to be redrawn. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/DrawingAttributes/PropertyDataChanged/CustomRenderedStroke.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/DrawingAttributes/PropertyDataChanged/CustomRenderedStroke.vb" id="Snippet1"::: diff --git a/xml/System.Windows.Ink/EllipseStylusShape.xml b/xml/System.Windows.Ink/EllipseStylusShape.xml index bd117d11f47..a73c250512e 100644 --- a/xml/System.Windows.Ink/EllipseStylusShape.xml +++ b/xml/System.Windows.Ink/EllipseStylusShape.xml @@ -24,14 +24,14 @@ Represents a stylus tip shaped like an ellipse. - and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: + ]]> @@ -44,14 +44,14 @@ Initializes a new instance of the class. - and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: + ]]> @@ -91,14 +91,14 @@ The height of the stylus shape. Initializes a new instance of the class with the specified width and height. - and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: + ]]> @@ -134,14 +134,14 @@ The angle of the stylus shape. Initializes a new instance of the class with the specified width, height, and angle. - and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.Windows.Ink/GestureRecognizer.xml b/xml/System.Windows.Ink/GestureRecognizer.xml index 6e02e7953d2..6f164d5977b 100644 --- a/xml/System.Windows.Ink/GestureRecognizer.xml +++ b/xml/System.Windows.Ink/GestureRecognizer.xml @@ -31,7 +31,7 @@ identifies an ink gesture. You can set the to recognize all or a subset of application gestures. To set the to recognize a subset of the available gestures, pass an array to the constructor or use the method. To determine whether a contains a gesture, call the method. + A identifies an ink gesture. You can set the to recognize all or a subset of application gestures. To set the to recognize a subset of the available gestures, pass an array to the constructor or use the method. To determine whether a contains a gesture, call the method. ## XAML Text Usage @@ -120,7 +120,7 @@ constructor to create a that recognizes a subset of the application gestures. + Use the constructor to create a that recognizes a subset of the application gestures. @@ -167,10 +167,10 @@ when you finish using the . The method leaves the in an unusable state. Therefore, after calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. + Call when you finish using the . The method leaves the in an unusable state. Therefore, after calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -247,7 +247,7 @@ method. + The following example demonstrates how to determine whether the gesture recognizer is available before calling the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/GestureRecognizer/Overview/Gesture.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GestureControl/VisualBasic/Gesture.vb" id="Snippet8"::: @@ -296,7 +296,7 @@ method is sorted by the property. For example, may return a array with the following values: + The array returned by the method is sorted by the property. For example, may return a array with the following values: |Index|ApplicationGesture|RecognitionConfidence| |-----------|------------------------|---------------------------| @@ -308,7 +308,7 @@ This means that the recognizes that it is very likely that the is a check mark, relatively likely that the in not a gesture, and not at all likely that the is a curlicue or a double curlicue. > [!NOTE] -> The method can return an array with at a higher than other application gestures. This means that it is more likely that the is not a gesture, as opposed to a gesture that has a lower . +> The method can return an array with at a higher than other application gestures. This means that it is more likely that the is not a gesture, as opposed to a gesture that has a lower . diff --git a/xml/System.Windows.Ink/IncrementalHitTester.xml b/xml/System.Windows.Ink/IncrementalHitTester.xml index ceb0045236f..19ff309dbb8 100644 --- a/xml/System.Windows.Ink/IncrementalHitTester.xml +++ b/xml/System.Windows.Ink/IncrementalHitTester.xml @@ -258,12 +258,12 @@ method when the finishes hit testing. + Call the method when the finishes hit testing. ## Examples - The following example demonstrates how to call after using an . This example assumes that there is an called `eraseTester`. + The following example demonstrates how to call after using an . This example assumes that there is an called `eraseTester`. :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet10"::: @@ -309,7 +309,7 @@ returns `true` until is called. Then it returns `false`. + The returns `true` until is called. Then it returns `false`. diff --git a/xml/System.Windows.Ink/IncrementalLassoHitTester.xml b/xml/System.Windows.Ink/IncrementalLassoHitTester.xml index e789946e973..0dadfa053a8 100644 --- a/xml/System.Windows.Ink/IncrementalLassoHitTester.xml +++ b/xml/System.Windows.Ink/IncrementalLassoHitTester.xml @@ -24,19 +24,19 @@ Dynamically hit tests a with a lasso. - hit tests strokes by determining whether a lasso path surrounds it. Use the method in the stylus events to add the points to the . When the points added to the selects or unselects a , the raises the event - - - -## Examples - The following example demonstrates how to dynamically select strokes in a custom control. For the entire sample, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control) - + hit tests strokes by determining whether a lasso path surrounds it. Use the method in the stylus events to add the points to the . When the points added to the selects or unselects a , the raises the event + + + +## Examples + The following example demonstrates how to dynamically select strokes in a custom control. For the entire sample, see [How to: Select Ink from a Custom Control](/dotnet/framework/wpf/advanced/how-to-select-ink-from-a-custom-control) + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkPresenter/DetachVisuals/InkSelector.cs" id="Snippet18"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/InkSelector.vb" id="Snippet18"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/InkSelector.vb" id="Snippet18"::: + ]]> @@ -132,14 +132,14 @@ Occurs when the lasso path selects or unselects an ink . - diff --git a/xml/System.Windows.Ink/IncrementalStrokeHitTester.xml b/xml/System.Windows.Ink/IncrementalStrokeHitTester.xml index 8ac27b95d6f..415004f62b5 100644 --- a/xml/System.Windows.Ink/IncrementalStrokeHitTester.xml +++ b/xml/System.Windows.Ink/IncrementalStrokeHitTester.xml @@ -24,19 +24,19 @@ Dynamically hit tests a stroke with an eraser path. - hit tests strokes by determining when a eraser path intersects that stroke. Use the method in the stylus events to add the points to the . When the points added to the intersect a , the raises the event. - - - -## Examples - The following example demonstrates how to dynamically erase a portion of a . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + hit tests strokes by determining when a eraser path intersects that stroke. Use the method in the stylus events to add the points to the . When the points added to the intersect a , the raises the event. + + + +## Examples + The following example demonstrates how to dynamically erase a portion of a . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet2"::: + ]]> @@ -133,14 +133,14 @@ Occurs when the intersects an ink . - . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + . To create a control that enables a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Windows.Ink/Stroke.xml b/xml/System.Windows.Ink/Stroke.xml index 08d20e66fa1..720f7b5e2b5 100644 --- a/xml/System.Windows.Ink/Stroke.xml +++ b/xml/System.Windows.Ink/Stroke.xml @@ -419,12 +419,12 @@ method to perform custom drawing when you inherit from the class. + Override the method to perform custom drawing when you inherit from the class. ## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyStroke.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyStroke.vb" id="Snippet23"::: @@ -471,12 +471,12 @@ ## Remarks These attributes, such as color and width, are applied to the object as it is drawn. - Changing causes the event to fire. + Changing causes the event to fire. ## Examples - The following example sets the to make a stroke green. + The following example sets the to make a stroke green. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyBorder.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyBorder.vb" id="Snippet7"::: @@ -606,12 +606,12 @@ method returns a new that contains the stylus points that the uses when the property on the property is set to `true`. To get the stylus points that are used when is set to `false`, use the property. + The method returns a new that contains the stylus points that the uses when the property on the property is set to `true`. To get the stylus points that are used when is set to `false`, use the property. ## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyStroke.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyStroke.vb" id="Snippet23"::: @@ -703,9 +703,9 @@ method returns a that contains strokes that represent the segments of the that is within `lassoPoints`. does not change the original . + The method returns a that contains strokes that represent the segments of the that is within `lassoPoints`. does not change the original . - The method connects the first and last points in `lassoPoints` to create the lasso. + The method connects the first and last points in `lassoPoints` to create the lasso. @@ -753,7 +753,7 @@ method returns a that contains strokes that represent the segments of the that is within `bounds`. does not change the original . + The method returns a that contains strokes that represent the segments of the that is within `bounds`. does not change the original . @@ -810,9 +810,9 @@ method returns a that contains strokes that represent the segments of the that are outside of `lassoPoints`. does not change the original . + The method returns a that contains strokes that represent the segments of the that are outside of `lassoPoints`. does not change the original . - The method connects the first and last points in `lassoPoints` to create the lasso. + The method connects the first and last points in `lassoPoints` to create the lasso. @@ -860,7 +860,7 @@ method returns a that contains strokes that represent the segments of the that are outside of `bounds`. does not change the original . + The method returns a that contains strokes that represent the segments of the that are outside of `bounds`. does not change the original . @@ -910,7 +910,7 @@ method uses `eraserShape` to hit test the stroke along `eraserPath` and returns a that represent dissected segments. does not change the original . + The method uses `eraserShape` to hit test the stroke along `eraserPath` and returns a that represent dissected segments. does not change the original . @@ -964,7 +964,7 @@ method to get a to customize the shape of the . Consider caching the to avoid calling multiple times, which may impact performance. + Use the method to get a to customize the shape of the . Consider caching the to avoid calling multiple times, which may impact performance. ]]> @@ -1004,12 +1004,12 @@ method uses the , , , and properties of `drawingAttributes` to determine the . Consider caching the to avoid calling multiple times, which may impact performance. + The method uses the , , , and properties of `drawingAttributes` to determine the . Consider caching the to avoid calling multiple times, which may impact performance. ## Examples - The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + The following example demonstrates how to draw a circle at each of a . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyStroke.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyStroke.vb" id="Snippet23"::: @@ -1122,21 +1122,21 @@ methods to determine whether a intersects a certain point or is within specified bounds. + You can use the methods to determine whether a intersects a certain point or is within specified bounds. The following methods check whether the is intersected. -- +- -- +- -- +- The following methods check whether the is surrounded. -- +- -- +- ]]> @@ -1177,7 +1177,7 @@ method does when `diameter` is 1. + This method behaves the same way as the overloaded method does when `diameter` is 1. @@ -1228,7 +1228,7 @@ method connects the first and last points in `lassoPoints` to create the lasso. + The method connects the first and last points in `lassoPoints` to create the lasso. @@ -1279,7 +1279,7 @@ method uses `stylusShape` to hit test the stroke along `eraserPath`. + The method uses `stylusShape` to hit test the stroke along `eraserPath`. @@ -1415,7 +1415,7 @@ handles the event and calls the method. If you inherit from the class and your stroke's appearance is based on a custom state, you must call the method to raise the event. + The handles the event and calls the method. If you inherit from the class and your stroke's appearance is based on a custom state, you must call the method to raise the event. ]]> @@ -1454,7 +1454,7 @@ method of the base class so that registered delegates receive the event. + When overriding this method in a derived class, call the method of the base class so that registered delegates receive the event. ]]> @@ -1493,7 +1493,7 @@ method of the base class so that registered delegates receive the event. + When overriding this method in a derived class, call the method of the base class so that registered delegates receive the event. ]]> @@ -1532,12 +1532,12 @@ class and your stroke's appearance is based on a custom state, you must call the method to raise the event. The handles the event and calls the method. + If you inherit from the class and your stroke's appearance is based on a custom state, you must call the method to raise the event. The handles the event and calls the method. ## Examples - The following example draws a either as a solid stroke or as a series of objects, depending on the `Mode` property. The example calls the method, which in turn calls the where the stroke is drawn. + The following example draws a either as a solid stroke or as a series of objects, depending on the `Mode` property. The example calls the method, which in turn calls the where the stroke is drawn. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/CustomRenderedStroke.cs" id="Snippet24"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/CustomRenderedStroke.vb" id="Snippet24"::: @@ -1613,7 +1613,7 @@ method of the base class so that registered delegates receive the event. + When overriding this method in a derived class, call the method of the base class so that registered delegates receive the event. ]]> @@ -1806,15 +1806,15 @@ property on the property is set to `true`, use the method. + To get the stylus points that are used when the property on the property is set to `true`, use the method. > [!NOTE] -> The assigned to the property must have at least one in it. If you try to assign an empty to , or remove all the objects from , an exception occurs. +> The assigned to the property must have at least one in it. If you try to assign an empty to , or remove all the objects from , an exception occurs. ## Examples - The following example is part of an overridden that draws a circle at each . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. + The following example is part of an overridden that draws a circle at each . If the property is set to `true`, the is used to get the stylus points. Otherwise, the property is used. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyStroke.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyStroke.vb" id="Snippet23"::: diff --git a/xml/System.Windows.Ink/StrokeCollection.xml b/xml/System.Windows.Ink/StrokeCollection.xml index 31e8e7d22b6..70a8aaa8c2f 100644 --- a/xml/System.Windows.Ink/StrokeCollection.xml +++ b/xml/System.Windows.Ink/StrokeCollection.xml @@ -234,7 +234,7 @@ method raises the event. + The method raises the event. @@ -290,12 +290,12 @@ method enables you to add custom properties to a . You can then include extra information with a . + The method enables you to add custom properties to a . You can then include extra information with a . ## Examples - The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. + The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.vb" id="Snippet12"::: @@ -381,9 +381,9 @@ method connects the first and last points in `lassoPoints` to create the lasso. + The method connects the first and last points in `lassoPoints` to create the lasso. - The method raises the event for each it clips. + The method raises the event for each it clips. @@ -475,7 +475,7 @@ method copies each in the collection and the new references the new strokes. + The method copies each in the collection and the new references the new strokes. @@ -621,11 +621,11 @@ method connects the first and last points in `lassoPoints` to create the lasso. + The method connects the first and last points in `lassoPoints` to create the lasso. - The might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. + The might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. - The method raises the event for each it erases. + The method raises the event for each it erases. @@ -672,9 +672,9 @@ might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. All strokes that are entirely inside the specified rectangle are removed. + The might contain new strokes after the method is called. For example, if the specified area is through the middle of a , the erase method removes that and creates two new strokes. All strokes that are entirely inside the specified rectangle are removed. - The method raises the event for each it erases. + The method raises the event for each it erases. @@ -723,9 +723,9 @@ might contain new strokes after the method is called. For example, if `path` intersects the middle of a , the erase method removes that and creates two new strokes. + The might contain new strokes after the method is called. For example, if `path` intersects the middle of a , the erase method removes that and creates two new strokes. - The method raises the event for each it erases. + The method raises the event for each it erases. @@ -770,7 +770,7 @@ method returns a that takes the appearance of the rendered . For example, if is 10 display independent pixels (DIP) wide, the includes the entire width of the . + The method returns a that takes the appearance of the rendered . For example, if is 10 display independent pixels (DIP) wide, the includes the entire width of the . @@ -818,7 +818,7 @@ method returns an that considers a to be "hit" when the lasso path surrounds it. This is useful for implementing features, such as the ability to select a stroke with a lasso tool. The uses an to implement the lasso selection tool. + The method returns an that considers a to be "hit" when the lasso path surrounds it. This is useful for implementing features, such as the ability to select a stroke with a lasso tool. The uses an to implement the lasso selection tool. @@ -866,7 +866,7 @@ method returns an that considers a to be "hit" when the eraser path intersects it. This is useful for implementing features, such as the ability to erase part of a . The uses an when the property is set to . + The method returns an that considers a to be "hit" when the eraser path intersects it. This is useful for implementing features, such as the ability to erase part of a . The uses an when the property is set to . @@ -914,12 +914,12 @@ and methods enable you to add custom properties to a . You can then include extra information with a . + The and methods enable you to add custom properties to a . You can then include extra information with a . ## Examples - The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. + The following example demonstrates how to add and get custom property data. The `AddTimeStamp_Click` method uses the method to add the current time to the . The `GetTimeStap_Click` method uses the method to retrieve the timestamp from the . This example assumes that there is an called `inkCanvas1`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.vb" id="Snippet12"::: @@ -1246,7 +1246,7 @@ method returns -1 if `stroke` is not a member of the . + The method returns -1 if `stroke` is not a member of the . ]]> @@ -1428,7 +1428,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. - The method also allows derived classes to handle the event without attaching a delegate, which is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate, which is the preferred technique for handling the event in a derived class. ]]> @@ -1509,7 +1509,7 @@ method raises the event for each it removes. + The method raises the event for each it removes. @@ -1641,7 +1641,7 @@ method raises the event. + The method raises the event. @@ -1700,7 +1700,7 @@ method raises the event for each it replaces. + The method raises the event for each it replaces. @@ -1776,12 +1776,12 @@ method saves the as Ink Serialized Format (ISF). + The method saves the as Ink Serialized Format (ISF). ## Examples - The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. + The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.vb" id="Snippet10"::: @@ -1826,12 +1826,12 @@ method saves the as Ink Serialized Format (ISF). + The method saves the as Ink Serialized Format (ISF). ## Examples - The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. + The following example demonstrates how to save a to a file by using the method. This example assumes that there is an called `inkCanvas1`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/InkPresenter/DetachVisuals/Window2.xaml.vb" id="Snippet10"::: @@ -2011,7 +2011,7 @@ method affects the shape of the stylus tip, as well as the position of the strokes. For example, if you rotate a 90 degrees, the strokes move around an axis and the height and width of the strokes appear to be inverted. + When `applyToStylusTip` is `true`, the method affects the shape of the stylus tip, as well as the position of the strokes. For example, if you rotate a 90 degrees, the strokes move around an axis and the height and width of the strokes appear to be inverted. diff --git a/xml/System.Windows.Ink/StrokeHitEventArgs.xml b/xml/System.Windows.Ink/StrokeHitEventArgs.xml index 2f3bdcda8a6..ec0d4135a85 100644 --- a/xml/System.Windows.Ink/StrokeHitEventArgs.xml +++ b/xml/System.Windows.Ink/StrokeHitEventArgs.xml @@ -54,11 +54,11 @@ Returns the strokes that are a result of the eraser path erasing a stroke. A that contains the strokes that are created after the eraser path erases part of . - method returns a that contains the strokes that result in the eraser path erasing the where they intersect. If the eraser path intersects the middle of , the method returns a that contains two new strokes. - + method returns a that contains the strokes that result in the eraser path erasing the where they intersect. If the eraser path intersects the middle of , the method returns a that contains two new strokes. + ]]> diff --git a/xml/System.Windows.Ink/StylusShape.xml b/xml/System.Windows.Ink/StylusShape.xml index 5f2d8f5f2e5..0c59a7c226b 100644 --- a/xml/System.Windows.Ink/StylusShape.xml +++ b/xml/System.Windows.Ink/StylusShape.xml @@ -24,23 +24,23 @@ Represents the tip of a stylus. - specifies the shape, width, and height of the tip of a stylus. Methods such as and use a to determine the stylus tip of the hitting stroke. The and classes inherit from . - - -## XAML Text Usage - This class is not typically used in XAML. - - - -## Examples - The following example demonstrates how to create a and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that allows a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). - + specifies the shape, width, and height of the tip of a stylus. Methods such as and use a to determine the stylus tip of the hitting stroke. The and classes inherit from . + + +## XAML Text Usage + This class is not typically used in XAML. + + + +## Examples + The following example demonstrates how to create a and pass it to the method to erase a portion of a . This example assumes that there is a called `eraseTester` and that its event has been connected to the event handler defined in this example. To create a control that allows a user to erase ink, see [How to: Erase Ink on a Custom Control](/dotnet/framework/wpf/advanced/how-to-erase-ink-on-a-custom-control). + :::code language="csharp" source="~/snippets/csharp/System.Windows/StrokeCollectionConverter/Overview/InkEraser.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/StrokeCollectionConverter/Overview/InkEraser.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.Windows.Input.Manipulations/InertiaExpansionBehavior2D.xml b/xml/System.Windows.Input.Manipulations/InertiaExpansionBehavior2D.xml index 45d710cdb51..f3b823716f8 100644 --- a/xml/System.Windows.Input.Manipulations/InertiaExpansionBehavior2D.xml +++ b/xml/System.Windows.Input.Manipulations/InertiaExpansionBehavior2D.xml @@ -84,7 +84,7 @@ and properties; setting this property will set and to `NaN`. + This property value is mutually exclusive with the and properties; setting this property will set and to `NaN`. The default value for this property is `NaN`. @@ -131,11 +131,11 @@ ## Remarks Expansion must be proportional. The value of this property must equal the value of the property when the inertia processor starts; otherwise an exception is thrown. - This property value is mutually exclusive with the property; setting this property will set to `NaN`. + This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for this property is `NaN`. - must be a finite, non-negative number. The rate of expansion is determined by the property. + must be a finite, non-negative number. The rate of expansion is determined by the property. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. @@ -180,11 +180,11 @@ ## Remarks Expansion must be proportional. The value of this property must equal the value of the property when the inertia processor starts; otherwise an exception is thrown. - This property value is mutually exclusive with the property; setting this property will set to `NaN`. + This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for this property is `NaN`. - must be a finite, non-negative number. The rate of expansion is determined by the property. + must be a finite, non-negative number. The rate of expansion is determined by the property. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. @@ -229,7 +229,7 @@ ## Remarks This property is used by the inertia processor to calculate the scale factor for an element that is expanding. - For instance, if the and properties are set to 3.75, this informs the inertia processor that the starting expansion velocity is 3.75 coordinate units per millisecond along both axes (expansion must be proportional). + For instance, if the and properties are set to 3.75, this informs the inertia processor that the starting expansion velocity is 3.75 coordinate units per millisecond along both axes (expansion must be proportional). The scale factor associated with this rate of expansion depends upon the size of the element that is expanding. For a small element, this expansion velocity represents a larger scale factor than for a large element. You inform the inertia processor of the element size by setting the property. @@ -278,7 +278,7 @@ ## Remarks Expansion must be proportional. The value of this property must equal the value of the property when the inertia processor starts; otherwise an exception is thrown. - The default value for this property is `NaN`. Leaving this property and unchanged from the default or setting this property and to zero (0) will disable expansion inertia. + The default value for this property is `NaN`. Leaving this property and unchanged from the default or setting this property and to zero (0) will disable expansion inertia. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. @@ -323,7 +323,7 @@ ## Remarks Expansion must be proportional. The value of this property must equal the value of the property when the inertia processor starts; otherwise an exception is thrown. - The default value for this property is `NaN`. Leaving this property and unchanged from the default or setting this property and to zero (0) will disable expansion inertia. + The default value for this property is `NaN`. Leaving this property and unchanged from the default or setting this property and to zero (0) will disable expansion inertia. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. diff --git a/xml/System.Windows.Input.Manipulations/InertiaProcessor2D.xml b/xml/System.Windows.Input.Manipulations/InertiaProcessor2D.xml index 142332400ba..72d95681329 100644 --- a/xml/System.Windows.Input.Manipulations/InertiaProcessor2D.xml +++ b/xml/System.Windows.Input.Manipulations/InertiaProcessor2D.xml @@ -99,7 +99,7 @@ ## Examples - In the following example, an event handler for the event checks to see if inertia processing is running and if so, stops it by calling the method. + In the following example, an event handler for the event checks to see if inertia processing is running and if so, stops it by calling the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_onmanipulationstarted"::: @@ -241,9 +241,9 @@ and properties is the average position of all manipulators associated with an element. + The origin point represented by the and properties is the average position of all manipulators associated with an element. - A valid value for is any finite number. The default value is 0.0. + A valid value for is any finite number. The default value is 0.0. ]]> @@ -278,9 +278,9 @@ and properties is the average position of all manipulators associated with an element. + The origin point represented by the and properties is the average position of all manipulators associated with an element. - A valid value for is any finite number. The default value is 0.0. + A valid value for is any finite number. The default value is 0.0. ]]> diff --git a/xml/System.Windows.Input.Manipulations/InertiaRotationBehavior2D.xml b/xml/System.Windows.Input.Manipulations/InertiaRotationBehavior2D.xml index 5e591df932c..616cd50b1fd 100644 --- a/xml/System.Windows.Input.Manipulations/InertiaRotationBehavior2D.xml +++ b/xml/System.Windows.Input.Manipulations/InertiaRotationBehavior2D.xml @@ -84,9 +84,9 @@ property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. + This property represents the desired angular deceleration to be used during the inertia operation. This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. - must be a finite, non-negative number. + must be a finite, non-negative number. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. @@ -129,9 +129,9 @@ property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. + This property represents the desired ending rotation of the inertia operation. This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. - must be a finite, non-negative number. The direction of rotation is determined by the property. + must be a finite, non-negative number. The direction of rotation is determined by the property. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. diff --git a/xml/System.Windows.Input.Manipulations/InertiaTranslationBehavior2D.xml b/xml/System.Windows.Input.Manipulations/InertiaTranslationBehavior2D.xml index 08f5f287f0f..28cd173bd27 100644 --- a/xml/System.Windows.Input.Manipulations/InertiaTranslationBehavior2D.xml +++ b/xml/System.Windows.Input.Manipulations/InertiaTranslationBehavior2D.xml @@ -84,9 +84,9 @@ property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. + This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for both this property and is `NaN`. You must set one or the other property before inertia processing starts. - must be a finite, non-negative number. + must be a finite, non-negative number. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. @@ -129,9 +129,9 @@ property; setting this property will set to `NaN`. The default value for both this property and property is `NaN`. You must set one or the other property before inertia processing starts. + This property value is mutually exclusive with the property; setting this property will set to `NaN`. The default value for both this property and property is `NaN`. You must set one or the other property before inertia processing starts. - must be a finite, non-negative number. The direction of displacement is along the and vector. + must be a finite, non-negative number. The direction of displacement is along the and vector. This property cannot be set while the inertia processor is running; otherwise, an exception is thrown. diff --git a/xml/System.Windows.Input.Manipulations/Manipulation2DCompletedEventArgs.xml b/xml/System.Windows.Input.Manipulations/Manipulation2DCompletedEventArgs.xml index f4f35658eff..427fa198594 100644 --- a/xml/System.Windows.Input.Manipulations/Manipulation2DCompletedEventArgs.xml +++ b/xml/System.Windows.Input.Manipulations/Manipulation2DCompletedEventArgs.xml @@ -23,11 +23,11 @@ Represents data that is sent with a **ManipulationProcessor2D.Completed** event or an **InertiaProcessor2D.Completed** event. - event or an event. - + event or an event. + ]]> @@ -64,11 +64,11 @@ Gets the new x-coordinate of the composite position of the manipulation. The new x-coordinate of the composite position of the manipulation. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> @@ -105,11 +105,11 @@ Gets the new y-coordinate of the composite position of the manipulation. The new y-coordinate of the composite position of the manipulation. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> diff --git a/xml/System.Windows.Input.Manipulations/Manipulation2DDeltaEventArgs.xml b/xml/System.Windows.Input.Manipulations/Manipulation2DDeltaEventArgs.xml index f5bf0e21c80..b86d70ee9c4 100644 --- a/xml/System.Windows.Input.Manipulations/Manipulation2DDeltaEventArgs.xml +++ b/xml/System.Windows.Input.Manipulations/Manipulation2DDeltaEventArgs.xml @@ -125,11 +125,11 @@ Gets the new x-coordinate of the composite position of the manipulation. The new x-coordinate of the composite position of the manipulation. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> @@ -166,11 +166,11 @@ Gets the new y-coordinate of the composite position of the manipulation. The new y-coordinate of the composite position of the manipulation. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> diff --git a/xml/System.Windows.Input.Manipulations/Manipulation2DStartedEventArgs.xml b/xml/System.Windows.Input.Manipulations/Manipulation2DStartedEventArgs.xml index 66f4b2f3306..fc79643e906 100644 --- a/xml/System.Windows.Input.Manipulations/Manipulation2DStartedEventArgs.xml +++ b/xml/System.Windows.Input.Manipulations/Manipulation2DStartedEventArgs.xml @@ -23,15 +23,15 @@ Represents data that is sent with a event. - event checks to see if inertia processing is running and if so, stops it. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_onmanipulationstarted"::: - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_timestamp"::: - + event checks to see if inertia processing is running and if so, stops it. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_onmanipulationstarted"::: + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_timestamp"::: + ]]> @@ -68,11 +68,11 @@ Gets the x-coordinate of the origin. The x-coordinate of the origin. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> @@ -109,11 +109,11 @@ Gets the y-coordinate of the origin. The y-coordinate of the origin. - and properties is the average position of all manipulators associated with an element. - + and properties is the average position of all manipulators associated with an element. + ]]> diff --git a/xml/System.Windows.Input.Manipulations/ManipulationPivot2D.xml b/xml/System.Windows.Input.Manipulations/ManipulationPivot2D.xml index aa13a1c3fa2..e33b9ca6c57 100644 --- a/xml/System.Windows.Input.Manipulations/ManipulationPivot2D.xml +++ b/xml/System.Windows.Input.Manipulations/ManipulationPivot2D.xml @@ -28,18 +28,18 @@ ## Remarks When a object is assigned to the property of a object, it affects how the manipulation processor calculates rotational changes to an element when the element is being manipulated by a single manipulator. If more than one manipulator is being applied to the element during manipulation, the Pivot property is ignored. - In a single-manipulator scenario, an element can rotate as it is being dragged. The and properties of the object determine what position the element rotates around, and the property is used by the manipulation processor to calculate the amount of rotational change. + In a single-manipulator scenario, an element can rotate as it is being dragged. The and properties of the object determine what position the element rotates around, and the property is used by the manipulation processor to calculate the amount of rotational change. For instance, if the single manipulator is near the outer edge of the pivot point, the rotational change to the element as it is being dragged will be fairly large (depending upon the size of the element). If the manipulator is close to the center of the pivot point, very little (if any) rotation will occur. - Typically, the and properties represent the center of the element that is being manipulated, and the property represents the distance from the center of the element to its farthest edge. + Typically, the and properties represent the center of the element that is being manipulated, and the property represents the distance from the center of the element to its farthest edge. - As the element moves, the and properties of the object need to be updated so that rotation will continue to occur around the proper point. + As the element moves, the and properties of the object need to be updated so that rotation will continue to occur around the proper point. ## Examples - The following code example shows how the and properties for a pivot point are updated to match the center of the element that is being manipulated. + The following code example shows how the and properties for a pivot point are updated to match the center of the element that is being manipulated. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_manipulationprocessor2d"::: @@ -108,7 +108,7 @@ ## Remarks The property must be a positive, finite value that is greater than or equal to 1.0, or `NaN`. `NaN` indicates that there is no limit. The default value is `NaN`. - In practice, the pivot point is typically the center of the object that is being manipulated, and the value is the distance from the pivot point to the farthest edge of the object. Any pivoting that occurs within the distance is dampened. See for more information. + In practice, the pivot point is typically the center of the object that is being manipulated, and the value is the distance from the pivot point to the farthest edge of the object. Any pivoting that occurs within the distance is dampened. See for more information. ]]> diff --git a/xml/System.Windows.Input.Manipulations/ManipulationProcessor2D.xml b/xml/System.Windows.Input.Manipulations/ManipulationProcessor2D.xml index a6ef1d824ff..19879f03372 100644 --- a/xml/System.Windows.Input.Manipulations/ManipulationProcessor2D.xml +++ b/xml/System.Windows.Input.Manipulations/ManipulationProcessor2D.xml @@ -248,11 +248,11 @@ to something greater than zero. Any manipulator that is closer than that distance to the center of mass will not be included in rotation and scaling operations. + If a manipulator is extremely close to the center of mass of the manipulators currently being processed, a very small manipulator motion can become a very large change to rotation or scaling. To avoid this problem, set to something greater than zero. Any manipulator that is closer than that distance to the center of mass will not be included in rotation and scaling operations. A typical value to use should be based on the likely magnitude of "accidental" motions of the manipulators. For example, if the manipulator is a human finger touching a screen, a radius corresponding to a centimeter or so might be appropriate. - The value for must be a finite, non-negative number. + The value for must be a finite, non-negative number. ]]> @@ -342,7 +342,7 @@ ## Examples - In the following example, the method of a object is overridden to call the method with the list of objects set to null. + In the following example, the method of a object is overridden to call the method with the list of objects set to null. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input.Manipulations/InertiaProcessor2D/Complete/manipulationitem.xaml.cs" id="Snippet_manipulationitem_onlostmousecapture"::: diff --git a/xml/System.Windows.Input.Manipulations/Manipulator2D.xml b/xml/System.Windows.Input.Manipulations/Manipulator2D.xml index dbda12343a9..9cdd2b951cc 100644 --- a/xml/System.Windows.Input.Manipulations/Manipulator2D.xml +++ b/xml/System.Windows.Input.Manipulations/Manipulator2D.xml @@ -55,11 +55,11 @@ The y-coordinate of the manipulator. Creates a new object with the specified properties. - The -coordinate or -coordinate are , , or . These values are all invalid. @@ -201,7 +201,7 @@ . + The equivalent method for this operator is . ]]> @@ -243,7 +243,7 @@ . + The equivalent method for this operator is the negation of . ]]> @@ -281,11 +281,11 @@ Gets or sets the x-coordinate of this object. The x-coordinate of this object. - @@ -322,11 +322,11 @@ Gets or sets the y-coordinate of this object. The y-coordinate of this object. - diff --git a/xml/System.Windows.Input.StylusPlugIns/DynamicRenderer.xml b/xml/System.Windows.Input.StylusPlugIns/DynamicRenderer.xml index 2776cd386f5..64e34df1180 100644 --- a/xml/System.Windows.Input.StylusPlugIns/DynamicRenderer.xml +++ b/xml/System.Windows.Input.StylusPlugIns/DynamicRenderer.xml @@ -159,7 +159,7 @@ method to perform some work on the rendering thread. + The following example demonstrates how to use the method to perform some work on the rendering thread. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet19"::: @@ -239,7 +239,7 @@ method to dynamically render digital ink with a . + The following example demonstrates how to override the method to dynamically render digital ink with a . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet11"::: @@ -281,7 +281,7 @@ method. + The following example overrides the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet21"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet21"::: @@ -467,7 +467,7 @@ in the method. + To subscribe to this method, call in the method. ]]> @@ -698,7 +698,7 @@ in the method + To subscribe to this method, call in the method ]]> @@ -742,7 +742,7 @@ redraws the current stroke and any of the stylus points passed into the method. This method allows you to redraw a stroke while the user is still creating the stroke. The tablet pen must be touching the digitizer or the left mouse button must be pressed when is called. + The redraws the current stroke and any of the stylus points passed into the method. This method allows you to redraw a stroke while the user is still creating the stroke. The tablet pen must be touching the digitizer or the left mouse button must be pressed when is called. @@ -790,12 +790,12 @@ , you must attach the property to the by using the method. + When you use a , you must attach the property to the by using the method. ## Examples - The following example demonstrates how to create a and add the to the . To create a control that dynamically renders ink, see [Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control). + The following example demonstrates how to create a and add the to the . To create a control that dynamically renders ink, see [Creating an Ink Input Control](/dotnet/framework/wpf/advanced/creating-an-ink-input-control). :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/StylusControl.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/StylusControl.vb" id="Snippet3"::: diff --git a/xml/System.Windows.Input.StylusPlugIns/RawStylusInput.xml b/xml/System.Windows.Input.StylusPlugIns/RawStylusInput.xml index 1ff7d47b80a..a6d71e36255 100644 --- a/xml/System.Windows.Input.StylusPlugIns/RawStylusInput.xml +++ b/xml/System.Windows.Input.StylusPlugIns/RawStylusInput.xml @@ -32,7 +32,7 @@ ## Examples - The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application thread. + The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application thread. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.vb" id="Snippet12"::: @@ -72,7 +72,7 @@ method. To create a that restricts ink to a certain area, see the overview. + The following example demonstrates how to change the stylus points in the method. To create a that restricts ink to a certain area, see the overview. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/FilterPlugin.vb" id="Snippet8"::: @@ -114,18 +114,18 @@ on the pen thread. Because accurate hit-testing cannot be performed on the pen thread, some elements might occasionally receive stylus input intended for other elements. If you need to be sure the input was routed correctly before performing an operation, call the method in the method that occurs on the pen thread. The following table lists where to call to subscribe to the application thread's method. + The pen's input is routed to an element's on the pen thread. Because accurate hit-testing cannot be performed on the pen thread, some elements might occasionally receive stylus input intended for other elements. If you need to be sure the input was routed correctly before performing an operation, call the method in the method that occurs on the pen thread. The following table lists where to call to subscribe to the application thread's method. -|Call in this method|To subscribe to this method| +|Call in this method|To subscribe to this method| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| -||| -||| -||| +||| +||| +||| ## Examples - The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application thread. + The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application thread. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.vb" id="Snippet12"::: @@ -173,12 +173,12 @@ and , can get the set by by calling the method. + Events such as and , can get the set by by calling the method. ## Examples - The following example demonstrates how to change the stylus points in the method. To create a that restricts ink to a certain area, see the overview. + The following example demonstrates how to change the stylus points in the method. To create a that restricts ink to a certain area, see the overview. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/FilterPlugin.vb" id="Snippet8"::: diff --git a/xml/System.Windows.Input.StylusPlugIns/StylusPlugIn.xml b/xml/System.Windows.Input.StylusPlugIns/StylusPlugIn.xml index 0e6771b1913..a62ce59498c 100644 --- a/xml/System.Windows.Input.StylusPlugIns/StylusPlugIn.xml +++ b/xml/System.Windows.Input.StylusPlugIns/StylusPlugIn.xml @@ -31,17 +31,17 @@ To intercept stylus points from the hardware, create a class that inherits from the class. The class has the following methods that you can override to manipulate objects on a thread in the pen thread pool. -- +- -- +- -- +- -- +- -- +- - The pen's input is routed to an element's on the pen thread. Since accurate hit-testing cannot be performed on the pen thread, some elements might occasionally receive stylus input intended for other elements. If you need to make sure the input was routed correctly before performing an operation, subscribe to and perform the operation in the , , or method. These methods are invoked by the main application thread after accurate hit-testing has been performed. To subscribe to these methods, call the method in the method that occurs on the pen thread. For example, if you call in , the occurs. + The pen's input is routed to an element's on the pen thread. Since accurate hit-testing cannot be performed on the pen thread, some elements might occasionally receive stylus input intended for other elements. If you need to make sure the input was routed correctly before performing an operation, subscribe to and perform the operation in the , , or method. These methods are invoked by the main application thread after accurate hit-testing has been performed. To subscribe to these methods, call the method in the method that occurs on the pen thread. For example, if you call in , the occurs. > [!NOTE] > If you use a inside a control, you should test the plug-in and control extensively to make sure they do not throw any unintended exceptions. @@ -117,7 +117,7 @@ of the when it is added to the collection. + The following example shows the of the when it is added to the collection. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet22"::: @@ -209,7 +209,7 @@ ## Examples - The following example checks the value of the property in the method. + The following example checks the value of the property in the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet16"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet16"::: @@ -259,12 +259,12 @@ - The is a member of a . -- The of the is visible and enabled. +- The of the is visible and enabled. ## Examples - The following example demonstrates how to override the method. + The following example demonstrates how to override the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet18"::: @@ -303,7 +303,7 @@ of the when it is added to the collection. + The following example shows the of the when it is added to the collection. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet22"::: @@ -342,7 +342,7 @@ property in the method. + The following example checks the value of the property in the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet16"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet16"::: @@ -381,12 +381,12 @@ method to allocate and clean up resources used by the . + Use the method to allocate and clean up resources used by the . ## Examples - The following example demonstrates how to override the method. + The following example demonstrates how to override the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/CustomDynamicRenderer.vb" id="Snippet18"::: @@ -462,7 +462,7 @@ ## Examples - The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. + The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/FilterPlugin.vb" id="Snippet8"::: @@ -507,12 +507,12 @@ in the method. + To subscribe to this method, call in the method. ## Examples - The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application UI thread. The relationship between and on is identical. + The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application UI thread. The relationship between and on is identical. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.vb" id="Snippet12"::: @@ -653,7 +653,7 @@ ## Examples - The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. + The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/FilterPlugin.vb" id="Snippet9"::: @@ -698,12 +698,12 @@ in the method + To subscribe to this method, call in the method ## Examples - The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application UI thread. The relationship between and on is identical. + The following example creates a that checks for the gesture. The calls in to subscribe to the method, which is called from the application UI thread. The relationship between and on is identical. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.vb" id="Snippet12"::: @@ -750,7 +750,7 @@ ## Examples - The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. + The following example demonstrates how to override the method. To create a that restricts ink to a certain area, see the overview. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/FilterPlugin.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/FilterPlugin.vb" id="Snippet10"::: @@ -795,12 +795,12 @@ in the method + To subscribe to this method, call in the method ## Examples - The following example creates a that checks for the gesture. The checks for the gesture in the method, which is called from the application UI thread. + The following example creates a that checks for the gesture. The checks for the gesture in the method, which is called from the application UI thread. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/StylusPlugIns/RecognizerPlugin.vb" id="Snippet12"::: diff --git a/xml/System.Windows.Input/AccessKeyManager.xml b/xml/System.Windows.Input/AccessKeyManager.xml index fd68cf41008..60ee28c3401 100644 --- a/xml/System.Windows.Input/AccessKeyManager.xml +++ b/xml/System.Windows.Input/AccessKeyManager.xml @@ -24,17 +24,17 @@ Maintains the registration of all access keys and the handling of interop keyboard commands between Windows Forms, Win32, and Windows Presentation Foundation (WPF). - object is created on demand with one per . - - The is attached as an event handler for and exposes methods to and access keys. - - When the registered access key is pressed, the calls the method on the target element. - - An element can be associated with any number of access keys. - + object is created on demand with one per . + + The is attached as an event handler for and exposes methods to and access keys. + + When the registered access key is pressed, the calls the method on the target element. + + An element can be associated with any number of access keys. + ]]> @@ -64,13 +64,13 @@ Occurs when the access key is pressed. - field will never be raised; it is used to identify classes that define new scopes. - + field will never be raised; it is used to identify classes that define new scopes. + ]]> @@ -249,13 +249,13 @@ The element to associate with. Associates the specified access keys with the specified element. - method of `element` is called. - - An element can be associated with any number of access keys. - + method of `element` is called. + + An element can be associated with any number of access keys. + ]]> diff --git a/xml/System.Windows.Input/AccessKeyPressedEventArgs.xml b/xml/System.Windows.Input/AccessKeyPressedEventArgs.xml index d0773c140e7..e0e4356b6f2 100644 --- a/xml/System.Windows.Input/AccessKeyPressedEventArgs.xml +++ b/xml/System.Windows.Input/AccessKeyPressedEventArgs.xml @@ -36,13 +36,13 @@ Initializes a new instance of the class. - - - - + + + + ]]> @@ -143,11 +143,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> @@ -228,11 +228,11 @@ Gets the scope for the element that raised this event. The element's scope. - diff --git a/xml/System.Windows.Input/ApplicationCommands.xml b/xml/System.Windows.Input/ApplicationCommands.xml index 07aadf6d917..d6fbcef1785 100644 --- a/xml/System.Windows.Input/ApplicationCommands.xml +++ b/xml/System.Windows.Input/ApplicationCommands.xml @@ -27,9 +27,9 @@ class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command with a . For example, if the command is executed on a control, the logic which performs the command may not be provided by the control, so the application writer will be responsible for writing the logic that determines how the control will handle the command. + The commands in the class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command with a . For example, if the command is executed on a control, the logic which performs the command may not be provided by the control, so the application writer will be responsible for writing the logic that determines how the control will handle the command. - Many controls do provide implementation logic for many of the commands in the command library. For example, the class provides logic for the , , , , and commands. + Many controls do provide implementation logic for many of the commands in the command library. For example, the class provides logic for the , , , , and commands. For more information on commands and commanding see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). diff --git a/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml b/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml index 7bb9b8e1354..baa845f21bc 100644 --- a/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml +++ b/xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml @@ -27,14 +27,14 @@ , will call the method on a to determine if the command can or cannot execute on the current command target. If is set to `false` from an event handler, the command source will disable itself. For example, if a is acting as the command source for a command and the command cannot execute on the current command target, then the will gray itself out. + Typically, a command source, such a , will call the method on a to determine if the command can or cannot execute on the current command target. If is set to `false` from an event handler, the command source will disable itself. For example, if a is acting as the command source for a command and the command cannot execute on the current command target, then the will gray itself out. The event notifies a command source when the ability of a command to execute may have changed. ## Examples - The follow example creates a that returns `true` only if the command target is a control. First, is cast to a . If is a , is set to `true`; otherwise, it is set to `false`. + The follow example creates a that returns `true` only if the command target is a control. First, is cast to a . If is a , is set to `true`; otherwise, it is set to `false`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: @@ -87,12 +87,12 @@ and , are disabled when is `false` and enabled when the is `true`. + Many command sources, such as and , are disabled when is `false` and enabled when the is `true`. ## Examples - The follow example creates a that only returns true if the command target is a control. First the event data is cast to a . If it is a , is set to `true`; otherwise, it is set to `false`. + The follow example creates a that only returns true if the command target is a control. First the event data is cast to a . If it is a , is set to `true`; otherwise, it is set to `false`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcanexecute"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcanexecute"::: @@ -145,7 +145,7 @@ ## Examples - The following example creates a which handles multiple commands. If the property is equal to the command and the method `IsPlaying` returns `false`, is set to `true`; otherwise, is set to `false`. If the property is equal to the command and the method `IsPlaying` returns `true`, is set to `true`; otherwise, is set to `false`. + The following example creates a which handles multiple commands. If the property is equal to the command and the method `IsPlaying` returns `false`, is set to `true`; otherwise, is set to `false`. If the property is equal to the command and the method `IsPlaying` returns `true`, is set to `true`; otherwise, is set to `false`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewmultiplecanexecute"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewmultiplecanexecute"::: @@ -269,12 +269,12 @@ ## Remarks The command parameter is used to pass specific information to the command when it is executed. The type of the data is defined by the command. - can be `null`. Many commands do not process or expect command parameters. + can be `null`. Many commands do not process or expect command parameters. ## Examples - The following example shows up to use a as the command source for a custom command. The property of the is set to the custom called `customCommand` and the is used to pass the value of the property of a control. This is accomplishment by using databinding to bind the to the property. The converter in the binding expression is a custom which converts into an before binding it to the . + The following example shows up to use a as the command source for a custom command. The property of the is set to the custom called `customCommand` and the is used to pass the value of the property of a control. This is accomplishment by using databinding to bind the to the property. The converter in the binding expression is a custom which converts into an before binding it to the . :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml" id="Snippetinvalidatesampleslidercommandparameter"::: diff --git a/xml/System.Windows.Input/CanExecuteRoutedEventHandler.xml b/xml/System.Windows.Input/CanExecuteRoutedEventHandler.xml index c49e885b39d..44062a1c955 100644 --- a/xml/System.Windows.Input/CanExecuteRoutedEventHandler.xml +++ b/xml/System.Windows.Input/CanExecuteRoutedEventHandler.xml @@ -35,14 +35,14 @@ determines if the command associated with the event source is able to execute on the command target. If the command has a command source that specifies a target, then the target information can be obtained through `sender`. If the is not set, the element with keyboard focus is the target, and can also be obtained through `sender`. If it is determined that the command can execute on the target, then the property should be set to `true`; otherwise, set it to `false`. + The determines if the command associated with the event source is able to execute on the command target. If the command has a command source that specifies a target, then the target information can be obtained through `sender`. If the is not set, the element with keyboard focus is the target, and can also be obtained through `sender`. If it is determined that the command can execute on the target, then the property should be set to `true`; otherwise, set it to `false`. You do not need to rely on event data to determine the command, source, and target. You can limit the usage of the handler to known possible command invocations, although this is more difficult to accomplish if your command structure relies extensively on the command routing to execute the same command on successive potential targets in an event route. ## Examples - The following example shows a that sets to `true`. + The following example shows a that sets to `true`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml.cs" id="Snippetcommandhandlercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventHandler/Overview/Window1.xaml.vb" id="Snippetcommandhandlercanexecutehandler"::: diff --git a/xml/System.Windows.Input/CommandBinding.xml b/xml/System.Windows.Input/CommandBinding.xml index 9a6a18bc51e..b7c2839c446 100644 --- a/xml/System.Windows.Input/CommandBinding.xml +++ b/xml/System.Windows.Input/CommandBinding.xml @@ -29,9 +29,9 @@ ## Remarks A associates a command with the / and / events which implement and determine the status of the command. - When the or method of a is called, the / or the / events are raised on the command target. If the command target has a for the command, the appropriate handlers are called. If the command target does not have a for the command, the events are routed through the element tree until an element that has a is found. + When the or method of a is called, the / or the / events are raised on the command target. If the command target has a for the command, the appropriate handlers are called. If the command target does not have a for the command, the events are routed through the element tree until an element that has a is found. - A has limited use with an that is not a . This is because a binds the command to the and the which listen to the and routed events which are raised when the and method of the are called. + A has limited use with an that is not a . This is because a binds the command to the and the which listen to the and routed events which are raised when the and method of the are called. ]]> @@ -218,7 +218,7 @@ method on a is called, the event is raised on the command target. If the event is not handled, the event is raised. If the command target has a for the command, the handler for that is called. If the command target does not have a for the command, the event bubbles up the element tree searching for an element that has a associated with the command. + When the method on a is called, the event is raised on the command target. If the event is not handled, the event is raised. If the command target has a for the command, the handler for that is called. If the command target does not have a for the command, the event bubbles up the element tree searching for an element that has a associated with the command. ## Routed Event Information @@ -234,14 +234,14 @@ ## Examples - The following example creates a that maps an and a handler to the command. + The following example creates a that maps an and a handler to the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml" id="Snippetcommandhandlercommandbinding"::: :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window1.xaml.cs" id="Snippetcommandhandlerbindinginit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/CommandBindings/window1.xaml.vb" id="Snippetcommandhandlerbindinginit"::: - The following shows the which sets to `true`. + The following shows the which sets to `true`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml.cs" id="Snippetcommandhandlercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventHandler/Overview/Window1.xaml.vb" id="Snippetcommandhandlercanexecutehandler"::: @@ -293,14 +293,14 @@ that maps an and a handler to the command. + The following example creates a that maps an and a handler to the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml" id="Snippetcommandhandlercommandbinding"::: :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window1.xaml.cs" id="Snippetcommandhandlerbindinginit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/CommandBindings/window1.xaml.vb" id="Snippetcommandhandlerbindinginit"::: - The following shows the which sets to `true`. + The following shows the which sets to `true`. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml.cs" id="Snippetcommandhandlercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventHandler/Overview/Window1.xaml.vb" id="Snippetcommandhandlercanexecutehandler"::: @@ -363,7 +363,7 @@ ## Examples - The following example creates a that maps an and a handler to the command. + The following example creates a that maps an and a handler to the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/CommandBindings/Window11.xaml" id="Snippetcommandhandlercommandbinding"::: @@ -412,7 +412,7 @@ method on a is called, the event is raised on the command target if the command target has a for the command. Then the handler for that is called. If the command target does not have a for the command, the event bubbles up the element tree searching for an element that has a associated with the command. If the event is not handled, the event is raised. + When the method on a is called, the event is raised on the command target if the command target has a for the command. Then the handler for that is called. If the command target does not have a for the command, the event bubbles up the element tree searching for an element that has a associated with the command. If the event is not handled, the event is raised. ## Routed Event Information diff --git a/xml/System.Windows.Input/CommandBindingCollection.xml b/xml/System.Windows.Input/CommandBindingCollection.xml index d046eaae344..b53b188560d 100644 --- a/xml/System.Windows.Input/CommandBindingCollection.xml +++ b/xml/System.Windows.Input/CommandBindingCollection.xml @@ -35,23 +35,23 @@ Represents a collection of objects. - have a named - - . - - - -## Examples - The following example creates a and adds it to the of a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewwindowcommandbindingxaml"::: - + have a named + + . + + + +## Examples + The following example creates a and adds it to the of a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewwindowcommandbindingxaml"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: + ]]> @@ -66,15 +66,15 @@ Initializes a new instance of the class. - - - - + + + + ]]> @@ -174,16 +174,16 @@ Adds the specified to this . 0, if the operation was successful (note that this is not the index of the added item). - and adds it to the of a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewwindowcommandbindingxaml"::: - + and adds it to the of a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewwindowcommandbindingxaml"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcustomcommandbindingcodebehind"::: + ]]> @@ -508,11 +508,11 @@ if the collection has a fixed size; otherwise, . The default value is . - is never a fixed size; therefore, will always return `false`. - + is never a fixed size; therefore, will always return `false`. + ]]> @@ -548,11 +548,11 @@ if the collection is read-only; otherwise, . The default value is . - is never read-only; therefore, will always return `false`. - + is never read-only; therefore, will always return `false`. + ]]> @@ -588,11 +588,11 @@ if the collection is thread-safe; otherwise, . The default value is . - can be used to synchronize access to the collection. - + can be used to synchronize access to the collection. + ]]> @@ -767,11 +767,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -813,11 +813,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -858,11 +858,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -902,11 +902,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -947,11 +947,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -997,11 +997,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1040,11 +1040,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Input/CommandManager.xml b/xml/System.Windows.Input/CommandManager.xml index add2cb77cd8..14a1c5abb7c 100644 --- a/xml/System.Windows.Input/CommandManager.xml +++ b/xml/System.Windows.Input/CommandManager.xml @@ -29,11 +29,11 @@ ## Remarks The is responsible for managing routed commands. For more information about commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - Use to register a to a class as opposed to an instance. + Use to register a to a class as opposed to an instance. - Use to register an to a class as opposed to an instance. + Use to register an to a class as opposed to an instance. - The method forces the to raise the event. The event informs a command source to query the command it is associated with to determine whether or not the command can execute. + The method forces the to raise the event. The event informs a command source to query the command it is associated with to determine whether or not the command can execute. ]]> @@ -78,9 +78,9 @@ and an and attaches them to a which is a command source for the command. + The following example creates a and an and attaches them to a which is a command source for the command. - First, the is created and associated with the command. + First, the is created and associated with the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewcmdmanageraddhandlersxaml"::: @@ -92,7 +92,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: - And finally, the handlers are attached to the using the and . + And finally, the handlers are attached to the using the and . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: @@ -140,9 +140,9 @@ and an and attaches them to a which is a command source for the command. + The following example creates a and an and attaches them to a which is a command source for the command. - First, the is created and associated with the command. + First, the is created and associated with the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewcmdmanageraddhandlersxaml"::: @@ -154,7 +154,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: - And finally, the handlers are attached to the using the and . + And finally, the handlers are attached to the using the and . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: @@ -202,9 +202,9 @@ and an and attaches them to a which is a command source for the command. + The following example creates a and an and attaches them to a which is a command source for the command. - First, the is created and associated with the command. + First, the is created and associated with the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewcmdmanageraddhandlersxaml"::: @@ -216,7 +216,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: - Finally, the handlers are attached to the using the and . + Finally, the handlers are attached to the using the and . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: @@ -264,9 +264,9 @@ and an and attaches them to a which is a command source for the command. + The following example creates a and an and attaches them to a which is a command source for the command. - First, the is created and associated with the command. + First, the is created and associated with the command. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewcmdmanageraddhandlersxaml"::: @@ -278,7 +278,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanagercanexecutehandler"::: - Finally, the handlers are attached to the using the and . + Finally, the handlers are attached to the using the and . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewcmdmanageraddhandlers"::: @@ -457,12 +457,12 @@ only pays attention to certain conditions in determining when the command target has changed, such as change in keyboard focus. In situations where the does not sufficiently determine a change in conditions that cause a command to not be able to execute, can be called to force the to raise the event. + The only pays attention to certain conditions in determining when the command target has changed, such as change in keyboard focus. In situations where the does not sufficiently determine a change in conditions that cause a command to not be able to execute, can be called to force the to raise the event. ## Examples - The following example uses a to periodically call to force the to raise the event. + The following example uses a to periodically call to force the to raise the event. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimer"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimer"::: diff --git a/xml/System.Windows.Input/ComponentCommands.xml b/xml/System.Windows.Input/ComponentCommands.xml index 088a18a72b9..9f79e4fac7b 100644 --- a/xml/System.Windows.Input/ComponentCommands.xml +++ b/xml/System.Windows.Input/ComponentCommands.xml @@ -27,9 +27,9 @@ class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command via a . For example, if the command is executed on a control (the command target), the logic that performs the command may not be provided by the command target, so the application writer is responsible for writing the logic that determines how the command target handles the command. + The commands in the class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command via a . For example, if the command is executed on a control (the command target), the logic that performs the command may not be provided by the command target, so the application writer is responsible for writing the logic that determines how the command target handles the command. - Many controls do provide implementation logic, though, for many of the commands in the command library. For example, the class provides logic for the command, command, command, command, and command. See the class documentation for particular control classes for more information. + Many controls do provide implementation logic, though, for many of the commands in the command library. For example, the class provides logic for the command, command, command, command, and command. See the class documentation for particular control classes for more information. For more information on commands and commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). diff --git a/xml/System.Windows.Input/Cursor.xml b/xml/System.Windows.Input/Cursor.xml index aeb71ad225c..580a9ed74b6 100644 --- a/xml/System.Windows.Input/Cursor.xml +++ b/xml/System.Windows.Input/Cursor.xml @@ -245,7 +245,7 @@ is called, the cursor object is no longer valid. + After is called, the cursor object is no longer valid. ]]> diff --git a/xml/System.Windows.Input/Cursors.xml b/xml/System.Windows.Input/Cursors.xml index 2bcfab9eb03..21b789192e1 100644 --- a/xml/System.Windows.Input/Cursors.xml +++ b/xml/System.Windows.Input/Cursors.xml @@ -76,7 +76,7 @@ typically indicates that the system is loading information, but the user interface can handle input. + The typically indicates that the system is loading information, but the user interface can handle input. ## XAML Text Usage @@ -441,7 +441,7 @@ cursor provides a means of hiding the cursor. + The cursor provides a means of hiding the cursor. ## XAML Text Usage diff --git a/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml b/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml index 28b2c183241..f710e1310b3 100644 --- a/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml +++ b/xml/System.Windows.Input/ExecutedRoutedEventArgs.xml @@ -174,12 +174,12 @@ If this parameter is not needed, `null` can be passed. - Normally, the is used to pass specific information to the command when it is executed. The type of the data is defined by the command. + Normally, the is used to pass specific information to the command when it is executed. The type of the data is defined by the command. ## Examples - The following example creates an for a custom . The handler updates a with the current time and the property of a control that is passed to the handler through the . + The following example creates an for a custom . The handler updates a with the current time and the property of a control that is passed to the handler through the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampleexecuted"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampleexecuted"::: diff --git a/xml/System.Windows.Input/ExecutedRoutedEventHandler.xml b/xml/System.Windows.Input/ExecutedRoutedEventHandler.xml index a40afa2d5f0..eda611c590a 100644 --- a/xml/System.Windows.Input/ExecutedRoutedEventHandler.xml +++ b/xml/System.Windows.Input/ExecutedRoutedEventHandler.xml @@ -32,35 +32,35 @@ The event data. Represents the method that will handle the and routed events, as well as related attached events. - . Separating the implementation logic from the command allows the command to be invoked from different sources and types, and enables the centralization of command logic. - - This delegate is also used for and , which are attached events on the class that implements much of the commanding infrastructure. But most practical handlers will handle the events from a particular , rather than work at the level. - - Within , the following properties are generally of interest when you write an event handler for a routed event that results from an executed command: - -- reports the target where the command was executed. Once the command is executed, you can also think of the more generally in routed event terms, as the object that raised a routed event. - -- reports the command that executed. This property is useful if you use command bindings and if you write handlers that potentially handle multiple commands. - -- reports any command-specific parameters that were passed by the executing command. Not all commands use or expect command-specific parameters. - -- reports whether the routed event that resulted from the executed command was already handled by a different element along the route. For routed event handlers, it is a recommended practice to have handlers that do meaningful work when handling the event to set to `true`. This prevents typical handlers for the event from handling the event again further along the route. For more information on handling routed events, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - - This delegate also represents handlers for and , which are attached events on the class that implements much of the commanding infrastructure. But most practical handlers will handle the events from a particular , rather than work at the level. - - For more information on commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - - - -## Examples - This example creates an that sets a visual property on the target when the command is executed. The example also includes the for the same command. - + . Separating the implementation logic from the command allows the command to be invoked from different sources and types, and enables the centralization of command logic. + + This delegate is also used for and , which are attached events on the class that implements much of the commanding infrastructure. But most practical handlers will handle the events from a particular , rather than work at the level. + + Within , the following properties are generally of interest when you write an event handler for a routed event that results from an executed command: + +- reports the target where the command was executed. Once the command is executed, you can also think of the more generally in routed event terms, as the object that raised a routed event. + +- reports the command that executed. This property is useful if you use command bindings and if you write handlers that potentially handle multiple commands. + +- reports any command-specific parameters that were passed by the executing command. Not all commands use or expect command-specific parameters. + +- reports whether the routed event that resulted from the executed command was already handled by a different element along the route. For routed event handlers, it is a recommended practice to have handlers that do meaningful work when handling the event to set to `true`. This prevents typical handlers for the event from handling the event again further along the route. For more information on handling routed events, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). + + This delegate also represents handlers for and , which are attached events on the class that implements much of the commanding infrastructure. But most practical handlers will handle the events from a particular , rather than work at the level. + + For more information on commanding, see [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). + + + +## Examples + This example creates an that sets a visual property on the target when the command is executed. The example also includes the for the same command. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/ExecutedRoutedEventHandler/Overview/Window1.xaml.cs" id="Snippetcustom_routedcommandhandlers"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/ExecutedRoutedEventHandler/Overview/window1.xaml.vb" id="Snippetcustom_routedcommandhandlers"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/ExecutedRoutedEventHandler/Overview/window1.xaml.vb" id="Snippetcustom_routedcommandhandlers"::: + ]]> diff --git a/xml/System.Windows.Input/FocusManager.xml b/xml/System.Windows.Input/FocusManager.xml index 31381c1c59a..30dc0ec1c23 100644 --- a/xml/System.Windows.Input/FocusManager.xml +++ b/xml/System.Windows.Input/FocusManager.xml @@ -29,17 +29,17 @@ ## Remarks In Windows Presentation Foundation (WPF) there are two concepts concerning focus: keyboard focus and logical focus. - Keyboard focus pertains to the element that is currently receiving keyboard input. There can be only one element with keyboard focus. This element with keyboard focus has set to `true`. returns the element with keyboard focus. + Keyboard focus pertains to the element that is currently receiving keyboard input. There can be only one element with keyboard focus. This element with keyboard focus has set to `true`. returns the element with keyboard focus. - Logical focus pertains to the within a specific focus scope. + Logical focus pertains to the within a specific focus scope. - A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. - There can be multiple elements with logical focus, but there can only be one element with logical focus within a single focus scope. An element with logical focus does not necessarily have keyboard focus, but an element with keyboard focus will have logical focus. It is possible to define a focus scope within a focus scope. In this case, both the parent focus scope and the child focus scope can have a . + There can be multiple elements with logical focus, but there can only be one element with logical focus within a single focus scope. An element with logical focus does not necessarily have keyboard focus, but an element with keyboard focus will have logical focus. It is possible to define a focus scope within a focus scope. In this case, both the parent focus scope and the child focus scope can have a . The following scenario illustrates how keyboard focus and logical focus change in a WPF application that has a with a and a that has a . When keyboard focus changes from the to the , the losses keyboard focus but retains logical focus for the focus scope. The obtains keyboard focus and obtains logical focus for the focus scope. When keyboard focus returns to the root , the element in focus scope with logical focus will obtain keyboard focus, which in this case is the . The now has keyboard focus and logical focus. The loses keyboard focus, but retains logical focus for the focus scope. - The default value of on a , , , and is `true`. + The default value of on a , , , and is `true`. For more information on focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and the [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). @@ -138,9 +138,9 @@ is the element that has logical focus for a specific focus scope. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + The is the element that has logical focus for a specific focus scope. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - and can be used to get and set the focused element within the specified focus scope. + and can be used to get and set the focused element within the specified focus scope. ## Dependency Property Information @@ -234,17 +234,17 @@ ## Remarks -The is the element that has logical focus for a specific focus scope. An element that is a focus scope has set to `true`. +The is the element that has logical focus for a specific focus scope. An element that is a focus scope has set to `true`. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). If `element` is not a focus scope, this method will return `null`. - Use , to specify the element with logical focus within a specified focus scope. + Use , to specify the element with logical focus within a specified focus scope. ## Examples - The following example sets the element with logical focus by using the and it gets the element with logical focus by using the . + The following example sets the element with logical focus by using the and it gets the element with logical focus by using the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/FocusManager/GetFocusedElement/Window1.xaml.cs" id="Snippetfocusgetsetfocusedelement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/FocusManager/GetFocusedElement/window1.xaml.vb" id="Snippetfocusgetsetfocusedelement"::: @@ -289,9 +289,9 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele on a , , , is `true`. + The default value of on a , , , is `true`. - A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -336,7 +336,7 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -420,7 +420,7 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -472,9 +472,9 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele on a , , , is `true`. + The default value of on a , , , is `true`. - A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -634,16 +634,16 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele is the element that has logical focus for the specific focus scope. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + The is the element that has logical focus for the specific focus scope. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - It is possible to specify a focus scope that is an ancestor of the focus scope the element is in. For example, if a is a focus scope and its parent is a focus scope, a child of the could specify the as the focus scope when calling . The is then for both the focus scope and the focus scope. + It is possible to specify a focus scope that is an ancestor of the focus scope the element is in. For example, if a is a focus scope and its parent is a focus scope, a child of the could specify the as the focus scope when calling . The is then for both the focus scope and the focus scope. - will give the specified element logical focus in the specified focus scope and will attempt to give the element keyboard focus. + will give the specified element logical focus in the specified focus scope and will attempt to give the element keyboard focus. ## Examples - The following example sets the element with logical focus by using the and it gets the element with logical focus by using the . + The following example sets the element with logical focus by using the and it gets the element with logical focus by using the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/FocusManager/GetFocusedElement/Window1.xaml.cs" id="Snippetfocusgetsetfocusedelement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/FocusManager/GetFocusedElement/window1.xaml.vb" id="Snippetfocusgetsetfocusedelement"::: @@ -688,14 +688,14 @@ This object may or may not have keyboard focus. Keyboard focus refers to the ele within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. + A focus scope is a container element that keeps track of the within its scope. By default, the class is a focus scope as are the , , and classes. An element that is a focus scope has set to `true`. For more information on focus, keyboard focus, and logical focus, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). ## Examples - The follow example makes an element a focus scope by using . + The follow example makes an element a focus scope by using . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/FocusManager/GetFocusedElement/Window1.xaml.cs" id="Snippetfocussetisfocusscope"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/FocusManager/GetFocusedElement/window1.xaml.vb" id="Snippetfocussetisfocusscope"::: diff --git a/xml/System.Windows.Input/ICommand.xml b/xml/System.Windows.Input/ICommand.xml index 13599dbb607..136fd120cfb 100644 --- a/xml/System.Windows.Input/ICommand.xml +++ b/xml/System.Windows.Input/ICommand.xml @@ -95,7 +95,7 @@ ## ICommand in Windows Runtime apps - The interface is the code contract for commands that are written in .NET for Windows Runtime apps. These commands provide the commanding behavior for UI elements such as a Windows Runtime XAML `Button` and in particular an `AppBarButton`. If you're defining commands for Windows Runtime apps, you use basically the same techniques you'd use for defining commands for a .NET app. Implement the command by defining a class that implements and specifically implement the method. + The interface is the code contract for commands that are written in .NET for Windows Runtime apps. These commands provide the commanding behavior for UI elements such as a Windows Runtime XAML `Button` and in particular an `AppBarButton`. If you're defining commands for Windows Runtime apps, you use basically the same techniques you'd use for defining commands for a .NET app. Implement the command by defining a class that implements and specifically implement the method. XAML for Windows Runtime does not support `x:Static`, so don't attempt to use the `x:Static` markup extension if the command is used from Windows Runtime XAML. Also, the Windows Runtime does not have any predefined command libraries, so the XAML syntax shown here doesn't really apply for the case where you're implementing the interface and defining the command for Windows Runtime usage. @@ -185,7 +185,7 @@ ## Remarks -Typically, a command source calls the method when the event is raised. +Typically, a command source calls the method when the event is raised. ]]> @@ -246,7 +246,7 @@ Typically, a command source calls the on the command when this event occurs. If the command cannot execute, the command source disables itself. +Normally, a command source calls on the command when this event occurs. If the command cannot execute, the command source disables itself. ]]> diff --git a/xml/System.Windows.Input/ICommandSource.xml b/xml/System.Windows.Input/ICommandSource.xml index 5bfc8757ad7..4a3a1ce53b6 100644 --- a/xml/System.Windows.Input/ICommandSource.xml +++ b/xml/System.Windows.Input/ICommandSource.xml @@ -27,13 +27,13 @@ ## Remarks The command source defines how a command is invoked by that particular object. For example, if a is associated with a command, the command is invoked when the is clicked. - A command source will normally disable itself if the command it is associated with cannot execute on the current command target. For example, a associated with the command will gray itself out when the command cannot execute on the current command target. + A command source will normally disable itself if the command it is associated with cannot execute on the current command target. For example, a associated with the command will gray itself out when the command cannot execute on the current command target. - Normally, a command source will listen to the event on the command. This informs the command source when conditions change on the command target, such as loss of keyboard focus. The command source can then query the command using the method. + Normally, a command source will listen to the event on the command. This informs the command source when conditions change on the command target, such as loss of keyboard focus. The command source can then query the command using the method. Some of the classes in WPF that implement are: , , and . - In the Windows Presentation Foundation commanding system, the property on a is only applicable when the is a . If the is set on a and the corresponding command is not a , the command target is ignored. + In the Windows Presentation Foundation commanding system, the property on a is only applicable when the is a . If the is set on a and the corresponding command is not a , the command target is ignored. ]]> @@ -102,7 +102,7 @@ is used to pass specific information to the command when it is executed. The type of the data is defined by the command. + Normally, the is used to pass specific information to the command when it is executed. The type of the data is defined by the command. ]]> @@ -140,7 +140,7 @@ property on a is only applicable when the is a . If the is set on a and the corresponding command is not a , the command target is ignored. + In the Windows Presentation Foundation commanding system, the property on a is only applicable when the is a . If the is set on a and the corresponding command is not a , the command target is ignored. When used with a , the command target is the object on which the and events are raised. If the property is not set, the element with keyboard focus will be used as the target. diff --git a/xml/System.Windows.Input/IInputLanguageSource.xml b/xml/System.Windows.Input/IInputLanguageSource.xml index 15814782e7f..fdb87c782ae 100644 --- a/xml/System.Windows.Input/IInputLanguageSource.xml +++ b/xml/System.Windows.Input/IInputLanguageSource.xml @@ -22,13 +22,13 @@ Defines necessary facilities for an object that intends to behave as an input language source. - method to register an input language source with an . - + method to register an input language source with an . + ]]> @@ -60,11 +60,11 @@ Gets or sets the current input language for this input language source object. A object representing the current input language for this input language source object. - @@ -97,11 +97,11 @@ Initializes an input language source object. - @@ -134,11 +134,11 @@ Gets a list of input languages supported by this input language source object. An enumerable object that represents the list of input languages supported by this input language source object. - interface, and that supports enumerating a collection of objects, each representing a supported input language. - + interface, and that supports enumerating a collection of objects, each representing a supported input language. + ]]> @@ -171,11 +171,11 @@ Un-initializes an input language source object. - diff --git a/xml/System.Windows.Input/IManipulator.xml b/xml/System.Windows.Input/IManipulator.xml index 5df670e2fae..3c8683f5a96 100644 --- a/xml/System.Windows.Input/IManipulator.xml +++ b/xml/System.Windows.Input/IManipulator.xml @@ -91,7 +91,7 @@ property should be unique for each object of a certain type. For example, if the types `Manipulator1` and `Manipulator2` implement , all of the objects of type `Maniplulator1` must have unique values, but an object of type `Manipulator1` might have the same as an object of type `Manipulator2`. + The property should be unique for each object of a certain type. For example, if the types `Manipulator1` and `Manipulator2` implement , all of the objects of type `Maniplulator1` must have unique values, but an object of type `Manipulator1` might have the same as an object of type `Manipulator2`. ]]> diff --git a/xml/System.Windows.Input/InertiaExpansionBehavior.xml b/xml/System.Windows.Input/InertiaExpansionBehavior.xml index 429a3d11320..d6c9ad9c194 100644 --- a/xml/System.Windows.Input/InertiaExpansionBehavior.xml +++ b/xml/System.Windows.Input/InertiaExpansionBehavior.xml @@ -34,7 +34,7 @@ - Specify the desired deceleration of the inertia by setting the property. - Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -109,7 +109,7 @@ property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -157,7 +157,7 @@ property to specify the desired expansion of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired expansion of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). diff --git a/xml/System.Windows.Input/InertiaRotationBehavior.xml b/xml/System.Windows.Input/InertiaRotationBehavior.xml index 65eb5414582..9a921e7539f 100644 --- a/xml/System.Windows.Input/InertiaRotationBehavior.xml +++ b/xml/System.Windows.Input/InertiaRotationBehavior.xml @@ -34,7 +34,7 @@ - Specify the desired deceleration of the inertia by setting the property. - Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -109,7 +109,7 @@ property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -157,7 +157,7 @@ property to specify the desired rotation of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired rotation of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). diff --git a/xml/System.Windows.Input/InertiaTranslationBehavior.xml b/xml/System.Windows.Input/InertiaTranslationBehavior.xml index cf5b2e1dfa7..91fafd369c7 100644 --- a/xml/System.Windows.Input/InertiaTranslationBehavior.xml +++ b/xml/System.Windows.Input/InertiaTranslationBehavior.xml @@ -34,7 +34,7 @@ - Specify the desired deceleration of the inertia by setting the property. - Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -109,7 +109,7 @@ property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired deceleration of the inertia. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -157,7 +157,7 @@ property to specify the desired position of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. + Use the property to specify the desired position of the manipulation when inertia ends. Set either the or the , but not both. When you set one of these properties, the other property is changed to if it has a value. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). diff --git a/xml/System.Windows.Input/InputBinding.xml b/xml/System.Windows.Input/InputBinding.xml index 5afddf8fa19..102f82c45e1 100644 --- a/xml/System.Windows.Input/InputBinding.xml +++ b/xml/System.Windows.Input/InputBinding.xml @@ -39,9 +39,9 @@ ## Remarks You can specify that user input invokes a command by creating a . When the user performs the specified input, the that is set to the property is executed. - You can specify that the invokes a command that is defined on an object by creating a binding on the , , and properties. This enables you to define a custom command and associate it with user input. For more information, see the second example in the Examples section. + You can specify that the invokes a command that is defined on an object by creating a binding on the , , and properties. This enables you to define a custom command and associate it with user input. For more information, see the second example in the Examples section. - An can be defined on a specific object or at the class level by registering a with the . + An can be defined on a specific object or at the class level by registering a with the . The class itself does not support XAML usage because it does not expose a public parameterless constructor (there is a parameterless constructor, but it is protected). However, derived classes can expose a public constructor and therefore can set properties on the derived class that are inherited from with a XAML usage. Two existing -derived classes that can be instantiated in XAML and can set properties in XAML are and . The typical property in WPF programming that is set in XAML and takes one or more objects as values is the property. @@ -57,7 +57,7 @@ ## Examples - The following example shows how to use a to bind a to the command. When the key gesture is performed, the Open command is invoked. + The following example shows how to use a to bind a to the command. When the key gesture is performed, the Open command is invoked. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: @@ -79,7 +79,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/InputBinding/Overview/mainwindow.xaml.cs" id="Snippetinitializecommand"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/InputBinding/Overview/mainwindow.xaml.vb" id="Snippetinitializecommand"::: - Finally, the following example creates the user interface. The example adds a and a to a that contains a and a . When the user selects an item in the , they can change the color of the background to the selected color. In each case, the `CommandParameter` property is bound to the selected item in the , and the `Command` property is bound to the `ColorChangeCommand`. The , , and properties are bound to the corresponding properties on the `SimpleDelegateCommand` class. + Finally, the following example creates the user interface. The example adds a and a to a that contains a and a . When the user selects an item in the , they can change the color of the background to the selected color. In each case, the `CommandParameter` property is bound to the selected item in the , and the `Command` property is bound to the `ColorChangeCommand`. The , , and properties are bound to the corresponding properties on the `SimpleDelegateCommand` class. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/InputBinding/Overview/mainwindow.xaml" id="Snippetui"::: @@ -177,7 +177,7 @@ and ), or you will use this constructor as the base instantiation of a custom class. Although the class supports different input devices in principle, in practice you must choose which device the input binding will represent. You only can set only one value on the input binding, and gestures are device-specific. + If you are a software developer using existing input binding classes, you generally will not use this constructor, even if you are defining custom commands. Instead, you will either use constructors of derived classes ( and ), or you will use this constructor as the base instantiation of a custom class. Although the class supports different input devices in principle, in practice you must choose which device the input binding will represent. You only can set only one value on the input binding, and gestures are device-specific. @@ -305,7 +305,7 @@ ## Remarks The class does not support XAML usage because it does not expose a public parameterless constructor (it has a parameterless constructor, but it is protected). However, derived classes can expose a public constructor and therefore, can use properties that are inherited from . Two existing derived classes that can be instantiated in XAML and can set properties with XAML usages are and . - references a type converter that enables certain preexisting implementations to specify values in the form of a string. This type conversion behavior sets the attribute value form of this property. You can also bind the , , and properties to an that is defined on an object. This enables you to define a custom command and associate it with user input. For more information, see the second example in . + references a type converter that enables certain preexisting implementations to specify values in the form of a string. This type conversion behavior sets the attribute value form of this property. You can also bind the , , and properties to an that is defined on an object. This enables you to define a custom command and associate it with user input. For more information, see the second example in . ## XAML Attribute Usage @@ -333,7 +333,7 @@ ## Examples - The following example shows how to use a to bind a to the command. When the key gesture is performed, the Open command is invoked. + The following example shows how to use a to bind a to the command. When the key gesture is performed, the Open command is invoked. :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: @@ -379,9 +379,9 @@ ## Remarks The property is used to pass specific information to the command when it is executed. The type of the data is defined by the command. Many commands do not expect command parameters; for these commands, any command parameters passed will be ignored. - If the command that an input binding is associated with is a , the of the input binding is passed to the handlers through the and the event data when the command is processed. + If the command that an input binding is associated with is a , the of the input binding is passed to the handlers through the and the event data when the command is processed. - The data type and purpose of the command parameter are defined differently for each command and can be `null`. You can bind the , , and properties to an that is defined on an object. This enables you to define a custom command and associate it with user input. For more information, see the second example in . + The data type and purpose of the command parameter are defined differently for each command and can be `null`. You can bind the , , and properties to an that is defined on an object. This enables you to define a custom command and associate it with user input. For more information, see the second example in . The class does not support XAML usage because it does not expose a public parameterless constructor (it has a parameterless constructor, but it is protected). However, derived classes can expose a public constructor and therefore, can set properties that are inherited from with XAML usage. Two existing derived classes that can be instantiated in XAML and can set properties in XAML are and . @@ -502,7 +502,7 @@ property on an object is applicable only when the is a . If the is set on an and the corresponding command is not a , the command target is ignored. + In the Windows Presentation Foundation commanding system, the property on an object is applicable only when the is a . If the is set on an and the corresponding command is not a , the command target is ignored. When used with a , the command target is the object on which the and events are raised. If the property is not set, the element with keyboard focus is used as the target. @@ -657,7 +657,7 @@ ## Examples - The following example shows how to use a to bind a to a . When the ALT+L is pressed, the command is invoked. + The following example shows how to use a to bind a to a . When the ALT+L is pressed, the command is invoked. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml" id="Snippetkeybindingwithkeyandmodifiersxaml"::: diff --git a/xml/System.Windows.Input/InputBindingCollection.xml b/xml/System.Windows.Input/InputBindingCollection.xml index dc00682a00f..7ecc3a3e92d 100644 --- a/xml/System.Windows.Input/InputBindingCollection.xml +++ b/xml/System.Windows.Input/InputBindingCollection.xml @@ -35,23 +35,23 @@ Represents an ordered collection of objects. - have an named . All objects that derive from have an named . - - However, if these collections are set in XAML, then the items in the collection must be derived classes of rather than direct objects. This is because does not support a default public constructor. Therefore, the items in a that was set in XAML will typically be an derived class that does support a default public constructor, such as or . - - - -## Examples - The following example creates a and associates it with a . The is added to the on a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: - + have an named . All objects that derive from have an named . + + However, if these collections are set in XAML, then the items in the collection must be derived classes of rather than direct objects. This is because does not support a default public constructor. Therefore, the items in a that was set in XAML will typically be an derived class that does support a default public constructor, such as or . + + + +## Examples + The following example creates a and associates it with a . The is added to the on a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewkeybinding"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeybinding"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeybinding"::: + ]]> @@ -68,19 +68,19 @@ Initializes a new instance of the class. - - - - - - - - + + + + + + + + ]]> @@ -184,18 +184,18 @@ Adds the specified to this . Always returns 0. This deviates from the standard implementation for , which should return the index where the new item was added to the collection. - and associates it with a . The is added to the on a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: - + and associates it with a . The is added to the on a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewkeybinding"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeybinding"::: - - The XAML example does not literally use , but is called implicitly by the XAML processing support for collections. For details on XAML and collections, see [XAML Overview (WPF)](/dotnet/framework/wpf/advanced/xaml-overview-wpf). - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeybinding"::: + + The XAML example does not literally use , but is called implicitly by the XAML processing support for collections. For details on XAML and collections, see [XAML Overview (WPF)](/dotnet/framework/wpf/advanced/xaml-overview-wpf). + ]]> @@ -527,11 +527,11 @@ if the collection has a fixed size; otherwise, . The default is . - is never a fixed size; therefore, always returns `false`. - + is never a fixed size; therefore, always returns `false`. + ]]> @@ -573,11 +573,11 @@ if the collection is read-only; otherwise, . The default is . - is never read-only; therefore, always returns `false`. - + is never read-only; therefore, always returns `false`. + ]]> @@ -613,11 +613,11 @@ if the collection is thread safe; otherwise, . The default is . - can be used to synchronize access to the collection. - + can be used to synchronize access to the collection. + ]]> @@ -794,11 +794,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -838,11 +838,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -883,11 +883,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -927,11 +927,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -972,11 +972,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1022,11 +1022,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1065,11 +1065,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Input/InputEventArgs.xml b/xml/System.Windows.Input/InputEventArgs.xml index e834109292f..8bcbb5bb614 100644 --- a/xml/System.Windows.Input/InputEventArgs.xml +++ b/xml/System.Windows.Input/InputEventArgs.xml @@ -24,11 +24,11 @@ Provides data for input related events. - is the base class for Windows Presentation Foundation input event argument classes. - + is the base class for Windows Presentation Foundation input event argument classes. + ]]> @@ -105,13 +105,13 @@ Gets the input device that initiated this event. The input device associated with this event. - - - - + + + + ]]> @@ -148,11 +148,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/InputGestureCollection.xml b/xml/System.Windows.Input/InputGestureCollection.xml index db1c36c1e4c..9e56ffaf9ce 100644 --- a/xml/System.Windows.Input/InputGestureCollection.xml +++ b/xml/System.Windows.Input/InputGestureCollection.xml @@ -35,16 +35,16 @@ Represents an ordered collection of objects. - and adds it to the of a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: - + and adds it to the of a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewkeygestureoncmd"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeygestureoncmd"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeygestureoncmd"::: + ]]> @@ -151,16 +151,16 @@ Adds the specified to this . 0, if the operation was successful (note that this is not the index of the added item). - and adds it to the of a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: - + and adds it to the of a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml" id="Snippetcommandingoverviewxamlkeybinding"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/InputBindings/Window1.xaml.cs" id="Snippetcommandingoverviewkeygestureoncmd"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeygestureoncmd"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CanExecuteRoutedEventArgs/Overview/window1.xaml.vb" id="Snippetcommandingoverviewkeygestureoncmd"::: + ]]> the collection is read-only. @@ -487,11 +487,11 @@ if the collection has a fixed size; otherwise, . The default value is . - is `true`. - + is `true`. + ]]> @@ -566,11 +566,11 @@ if the collection is thread-safe; otherwise, . The default value is . - can be used to synchronize access to the collection. - + can be used to synchronize access to the collection. + ]]> @@ -776,11 +776,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -820,11 +820,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -865,11 +865,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -909,11 +909,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -954,11 +954,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1004,11 +1004,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1047,11 +1047,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Input/InputLanguageEventArgs.xml b/xml/System.Windows.Input/InputLanguageEventArgs.xml index 532b1394931..289f6f11210 100644 --- a/xml/System.Windows.Input/InputLanguageEventArgs.xml +++ b/xml/System.Windows.Input/InputLanguageEventArgs.xml @@ -24,11 +24,11 @@ Provides a base class for arguments for events dealing with a change in input language. - and classes, which in turn provide arguments for the and routed events, respectively. - + and classes, which in turn provide arguments for the and routed events, respectively. + ]]> @@ -70,13 +70,13 @@ A object representing the previous current input language. Initializes base class values for a new instance of a deriving class. - should call this constructor to ensure that values provided by the abstract base class are initialized properly. - - The constructors for and automatically call this base constructor. - + should call this constructor to ensure that values provided by the abstract base class are initialized properly. + + The constructors for and automatically call this base constructor. + ]]> @@ -118,11 +118,11 @@ Gets a object representing the new current input language. A object representing the new current input language. - constructor. - + constructor. + ]]> @@ -163,11 +163,11 @@ Gets a object representing the previous current input language. A object representing the previous current input language. - constructor. - + constructor. + ]]> diff --git a/xml/System.Windows.Input/InputLanguageManager.xml b/xml/System.Windows.Input/InputLanguageManager.xml index 3fd8531fb3d..99aa7e0123c 100644 --- a/xml/System.Windows.Input/InputLanguageManager.xml +++ b/xml/System.Windows.Input/InputLanguageManager.xml @@ -544,7 +544,7 @@ |Identifier field|| |Metadata properties set to `true`|None| - This property has no effect if the attached property is not available on the associated dependency object. + This property has no effect if the attached property is not available on the associated dependency object. ]]> diff --git a/xml/System.Windows.Input/InputManager.xml b/xml/System.Windows.Input/InputManager.xml index 162fc704d89..73a9ccefb14 100644 --- a/xml/System.Windows.Input/InputManager.xml +++ b/xml/System.Windows.Input/InputManager.xml @@ -607,7 +607,7 @@ The handlers attached to are invoked in reverse order so that handlers added by the users are invoked before handlers in the system. - Calling on the passed to the will cancel the processing of the input. + Calling on the passed to the will cancel the processing of the input. Input is processed in WPF in the follow stages: diff --git a/xml/System.Windows.Input/InputMethod.xml b/xml/System.Windows.Input/InputMethod.xml index 18ad8572b13..08f57c9ad8e 100644 --- a/xml/System.Windows.Input/InputMethod.xml +++ b/xml/System.Windows.Input/InputMethod.xml @@ -633,7 +633,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. ]]> @@ -692,7 +692,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. ]]> @@ -751,7 +751,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. ]]> @@ -853,7 +853,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. When this property is attached to a , the input method automatically switches to the preferred conversion mode when that **UIElement** gets the focus. @@ -916,7 +916,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. When this property is attached to a , the input method automatically switches to the preferred sentence mode when that gets the focus. @@ -979,7 +979,7 @@ and methods to set or read this attached property on a specified dependency object. + This is an attached property. Use the and methods to set or read this attached property on a specified dependency object. When this property is attached to a , the input method automatically switches to the preferred state (usually **On** or **Off**) when that **UIElement** gets the focus. @@ -1052,7 +1052,7 @@ method to determine the associated with a object. + The following example demonstrates how to use the method to determine the associated with a object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/ImeSentenceModeValues/Overview/Window1.xaml.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/ImeSentenceModeValues/Overview/window1.xaml.vb" id="Snippet2"::: diff --git a/xml/System.Windows.Input/InputScope.xml b/xml/System.Windows.Input/InputScope.xml index 7691848ea5b..dfad17e9e23 100644 --- a/xml/System.Windows.Input/InputScope.xml +++ b/xml/System.Windows.Input/InputScope.xml @@ -34,11 +34,11 @@ Represents information related to the scope of data provided by an input method. - and properties to get an for a particular element. - + and properties to get an for a particular element. + ]]> @@ -106,15 +106,15 @@ Gets or sets the input scope name. - A member of the enumeration specifying a name for this input scope. - + A member of the enumeration specifying a name for this input scope. + The default value is . - for an element. - + for an element. + ]]> Raised when an attempt is made to set this property to any value other than a valid member of the enumeration. @@ -151,8 +151,8 @@ Gets a collection of phrases to be used as suggested input patterns by input processors. - An object containing a collection of phrases to be used as suggested input patterns by input processors. This object implements the interface. - + An object containing a collection of phrases to be used as suggested input patterns by input processors. This object implements the interface. + This property has no default value. To be added. @@ -192,8 +192,8 @@ Gets or sets a regular expression to be used as a suggested text input pattern by input processors. - A string that defines a regular expression to be used as a suggested text input pattern by input processors. - + A string that defines a regular expression to be used as a suggested text input pattern by input processors. + This property has no default value. To be added. Raised when an attempt is made to set this property to **null**. @@ -234,15 +234,15 @@ Gets or sets a string that specifies any Speech Recognition Grammar Specification (SRGS) markup to be used as a suggested input pattern by input processors. - A string that specifies any SRGS markup to be used as a suggested input pattern by input processors. - + A string that specifies any SRGS markup to be used as a suggested input pattern by input processors. + This property has no default value. - Raised when an attempt is made to set this property to **null**. diff --git a/xml/System.Windows.Input/InputScopePhrase.xml b/xml/System.Windows.Input/InputScopePhrase.xml index 2b2141a093d..db07319570e 100644 --- a/xml/System.Windows.Input/InputScopePhrase.xml +++ b/xml/System.Windows.Input/InputScopePhrase.xml @@ -34,11 +34,11 @@ Represents a suggested input text pattern. - provides a set of pre-defined values. - + provides a set of pre-defined values. + ]]> @@ -111,11 +111,11 @@ A string specifying the initial value for the property. This value cannot be . Initializes a new instance of the class, taking a string specifying the of the input scope phrase. - enumeration provides a set of pre-defined values. - + enumeration provides a set of pre-defined values. + ]]> Raised if is . @@ -228,20 +228,20 @@ Gets or sets a descriptive name associated with the text input pattern for this . A string containing the descriptive name for this . - enumeration provides a set of pre-defined values. - - -## XAML Property Element Usage - -``` - - string - -``` - + enumeration provides a set of pre-defined values. + + +## XAML Property Element Usage + +``` + + string + +``` + ]]> diff --git a/xml/System.Windows.Input/Key.xml b/xml/System.Windows.Input/Key.xml index e784be3d27d..cc48155b1e0 100644 --- a/xml/System.Windows.Input/Key.xml +++ b/xml/System.Windows.Input/Key.xml @@ -33,11 +33,11 @@ Specifies the possible key values on a keyboard. - and , provide key state information through the object that is passed to the event handler. Key state information can also be obtained through the static methods on the class, such as and . The class reports the current state of the keyboard. - + and , provide key state information through the object that is passed to the event handler. Key state information can also be obtained through the static methods on the class, such as and . The class reports the current state of the keyboard. + ]]> diff --git a/xml/System.Windows.Input/KeyBinding.xml b/xml/System.Windows.Input/KeyBinding.xml index b859ae56a05..fe494e56899 100644 --- a/xml/System.Windows.Input/KeyBinding.xml +++ b/xml/System.Windows.Input/KeyBinding.xml @@ -27,13 +27,13 @@ associates a with a , such as a . is the primary implementation of the interface for the WPF commanding system . In general, when the is executed the command is invoked, although the command behavior is further influenced by command-specific factors such as the value. For more information on commanding, see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). + A associates a with a , such as a . is the primary implementation of the interface for the WPF commanding system . In general, when the is executed the command is invoked, although the command behavior is further influenced by command-specific factors such as the value. For more information on commanding, see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). With the exception of the function keys and the numeric keypad keys, a valid must contain exactly one and one or more . Function keys and numeric keypad keys do not require a modifier key in order to be a valid . It is possible to specify an invalid and a with an invalid associated gesture, either through XAML or code. For instance, there is no validation that prevents creating and binding a that contains only a nonfunction key, or only modifiers but no key. Such a will never attempt to invoke its associated command. - When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. + When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. - A can be defined on a specific object or at the class level by registering a on the class. The most typical way to define a is within the control template, setting the property in XAML by declaring one or more or elements. + A can be defined on a specific object or at the class level by registering a on the class. The most typical way to define a is within the control template, setting the property in XAML by declaring one or more or elements. @@ -313,7 +313,7 @@ ## Remarks With the exception of the function keys and the numeric keypad keys, a must contain a and one or more . - When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. + When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. ]]> @@ -386,7 +386,7 @@ ## Remarks With the exception of the function keys and the numeric keypad keys, a must contain a and one or more . - When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. + When defining a in Extensible Application Markup Language (XAML) there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify keys and modifiers as a single string, for example "CTRL+P". The second way is to define the attribute and the attributes of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the , , and the attributes are all set, the attribute which is defined last will be used for the . You can potentially have situations where for example a set last will overwrite just the Key component of a preceding Gesture but leave the Gesture's modifiers the same. In general, it is recommended that you use only the attribute from XAML; this will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. ## XAML Attribute Usage diff --git a/xml/System.Windows.Input/KeyConverter.xml b/xml/System.Windows.Input/KeyConverter.xml index df88eaf20d3..2f7cb543584 100644 --- a/xml/System.Windows.Input/KeyConverter.xml +++ b/xml/System.Windows.Input/KeyConverter.xml @@ -24,11 +24,11 @@ Converts a object to and from other types. - class only converts an instance to and from a . - + class only converts an instance to and from a . + ]]> @@ -134,11 +134,11 @@ if is of type ; otherwise, . - @@ -178,13 +178,13 @@ Attempts to convert the specified object to a , using the specified context. The converted object. - . - - `destinationType` must be . - + . + + `destinationType` must be . + ]]> diff --git a/xml/System.Windows.Input/KeyEventArgs.xml b/xml/System.Windows.Input/KeyEventArgs.xml index 709e8c85c7f..3452bd4a87e 100644 --- a/xml/System.Windows.Input/KeyEventArgs.xml +++ b/xml/System.Windows.Input/KeyEventArgs.xml @@ -57,7 +57,7 @@ The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - A key can be in both the up and toggled states or the down and toggled states. For this reason, determining whether a key is up or down is not as simple as checking the value as a numeric value. Instead, you should check the value by treating it as a flag enumeration. Use an `AND` comparison of the first bit. Alternatively, use the helper properties , , and to determine whether a given key is up, down, or toggled. + A key can be in both the up and toggled states or the down and toggled states. For this reason, determining whether a key is up or down is not as simple as checking the value as a numeric value. Instead, you should check the value by treating it as a flag enumeration. Use an `AND` comparison of the first bit. Alternatively, use the helper properties , , and to determine whether a given key is up, down, or toggled. ]]> @@ -140,7 +140,7 @@ returns , you can use this property to get the actual key that was entered. + A dead key, when pressed, produces no visible character but indicates that the key is to be combined with the character produced by the next letter key pressed. If returns , you can use this property to get the actual key that was entered. ]]> @@ -251,7 +251,7 @@ and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as a and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> @@ -288,7 +288,7 @@ class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified key is down. + The class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified key is down. @@ -385,7 +385,7 @@ class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified key is toggled. + The class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified key is toggled. @@ -433,7 +433,7 @@ class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified is up. + The class also provides information about the state of the keys on the keyboard. For instance, the method returns whether a specified is up. @@ -528,12 +528,12 @@ value as a numeric value. Instead, you should check the value by treating it as a flag enumeration. Use an `AND` comparison of the first bit. Alternatively, use the helper properties , , and to determine whether a given key is up, down, or toggled. + A key can be in both the up and toggled states or the down and toggled states. For this reason, determining whether a key is up or down is not as simple as checking the value as a numeric value. Instead, you should check the value by treating it as a flag enumeration. Use an `AND` comparison of the first bit. Alternatively, use the helper properties , , and to determine whether a given key is up, down, or toggled. ## Examples - The following example checks whether a key associated with an instance of is down by performing a bitwise `AND` comparison on the of the key and the enumeration value. + The following example checks whether a key associated with an instance of is down by performing a bitwise `AND` comparison on the of the key and the enumeration value. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeystatesdown"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeystatesdown"::: diff --git a/xml/System.Windows.Input/KeyGesture.xml b/xml/System.Windows.Input/KeyGesture.xml index ff7df2cc7f9..fa225c5fa94 100644 --- a/xml/System.Windows.Input/KeyGesture.xml +++ b/xml/System.Windows.Input/KeyGesture.xml @@ -41,7 +41,7 @@ You can use a to bind a to an , so that the command is invoked when the occurs. - For XAML usages, the property that is generally set in XAML is , in cases where the gesture represents both a standard key and a modifier key. You can also set the property to be just a function key, or just a modifier key combination. However, it is more common to set the property if the intended command binding is a function key with no modifiers, or if the intended command binding is for modifier keys only. + For XAML usages, the property that is generally set in XAML is , in cases where the gesture represents both a standard key and a modifier key. You can also set the property to be just a function key, or just a modifier key combination. However, it is more common to set the property if the intended command binding is a function key with no modifiers, or if the intended command binding is for modifier keys only. ## XAML Attribute Usage @@ -70,7 +70,7 @@ ## Examples - The following example shows how to bind the command to a using a . + The following example shows how to bind the command to a using a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml.cs" id="Snippetkeybindingwithkeyandmodifiers"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/InputBinding/.ctor/window1.xaml.vb" id="Snippetkeybindingwithkeyandmodifiers"::: @@ -310,7 +310,7 @@ ## Remarks If a display string was not set in the constructor, an empty string is returned. - If this property is empty, the method returns a string created from the and . + If this property is empty, the method returns a string created from the and . ]]> @@ -351,7 +351,7 @@ and with any necessary conversions being governed by the specified object. + If the display string was set by the constructor, that string is returned; otherwise, a string is created from the and with any necessary conversions being governed by the specified object. ]]> @@ -447,7 +447,7 @@ ## Examples - The following example shows how to test whether a matches the input associated with an instance of an . A event handler is created that compares the event data with the by using the method. + The following example shows how to test whether a matches the input associated with an instance of an . A event handler is created that compares the event data with the by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml.cs" id="Snippetkeydownhandlerkeygesturematches"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/InputBinding/.ctor/window1.xaml.vb" id="Snippetkeydownhandlerkeygesturematches"::: diff --git a/xml/System.Windows.Input/Keyboard.xml b/xml/System.Windows.Input/Keyboard.xml index dff99708f8a..5f14454546b 100644 --- a/xml/System.Windows.Input/Keyboard.xml +++ b/xml/System.Windows.Input/Keyboard.xml @@ -33,16 +33,16 @@ In order for an element to receive keyboard input, the element must be focusable. Most derived objects are focusable by default. Otherwise, to make an element focusable, set the property on the base element to `true`. For more information on the base elements, see [Base Elements Overview](/dotnet/framework/wpf/advanced/base-elements-overview). - classes, such as and , set the default value of to `false`. Therefore, for these objects to obtain keyboard focus, must be set to `true`. + classes, such as and , set the default value of to `false`. Therefore, for these objects to obtain keyboard focus, must be set to `true`. - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). The static members of the class delegate to the primary of the calling thread, so they are not necessarily thread-safe. ## Examples - The following example shows how to use the method to determine if a key is in the toggled state. If the passed to is toggled, the background of a button is changed. + The following example shows how to use the method to determine if a key is in the toggled state. If the passed to is toggled, the background of a button is changed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeyboardistoggled"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeyboardistoggled"::: @@ -490,7 +490,7 @@ method on restoration of focus when a menu is closed. + If focus is within a Win32 window, WPF calls the method on restoration of focus when a menu is closed. When leaving menu mode, Win32 focus is returned to the hosted child HWND, and no element has WPF focus. @@ -560,9 +560,9 @@ property on the base element to `true`. For more information on the base elements, see [Base Elements Overview](/dotnet/framework/wpf/advanced/base-elements-overview). classes, such as and , set the default value of to `false`; therefore, for these objects to obtain keyboard focus, must be set to `true`. + For an element to receive keyboard input, the element must be focusable. To make an element focusable, set the property on the base element to `true`. For more information on the base elements, see [Base Elements Overview](/dotnet/framework/wpf/advanced/base-elements-overview). classes, such as and , set the default value of to `false`; therefore, for these objects to obtain keyboard focus, must be set to `true`. - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). An element with keyboard focus also has logical focus for the focus scope the element belongs to. An element with logical focus may or may not have keyboard focus. @@ -608,7 +608,7 @@ set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). An element with keyboard focus also has logical focus for the focus scope the element belongs to. An element with logical focus may or may not have keyboard focus. @@ -660,12 +660,12 @@ ## Remarks is a bit field enumeration; therefore, it is possible for a key to be in multiple states. For example, a key could be in the pressed state as well as in the toggled state. Use bit comparison operations to determine the exact state or states the key is in. - The class provides a number of static methods which can also be used to obtain key state information. The methods are: , , and . + The class provides a number of static methods which can also be used to obtain key state information. The methods are: , , and . ## Examples - The following example shows how to use the method to determine if the key is in the state. A bit AND operation is used to compare the returned from and the state. If the key is down, the background of a is changed. + The following example shows how to use the method to determine if the key is in the state. A bit AND operation is used to compare the returned from and the state. If the key is down, the background of a is changed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeyboardgetkeystates"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeyboardgetkeystates"::: @@ -703,7 +703,7 @@ ## Remarks This is an attached event. WPF implements attached events as routed events. Attached events are fundamentally a XAML language concept for referencing events that can be handled on objects that do not define that event, which WPF expands upon by also enabling the event to traverse a route. Attached events do not have a direct handling syntax in code; to attach handlers for a routed event in code, you use a designated Add*Handler method. For details, see [Attached Events Overview](/dotnet/framework/wpf/advanced/attached-events-overview). - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). If the event or the event is handled, keyboard focus does change. @@ -805,12 +805,12 @@ method can be used to determine the set of states of a specific key. + The method can be used to determine the set of states of a specific key. ## Examples - The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, the background of a is changed. + The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, the background of a is changed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeyboardiskeydown"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeyboardiskeydown"::: @@ -856,12 +856,12 @@ method can be used to determine the set of states of a specific key. + The method can be used to determine the set of states of a specific key. ## Examples - The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, then the background of a is changed. + The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, then the background of a is changed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeyboardistoggled"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeyboardistoggled"::: @@ -907,12 +907,12 @@ method can be used to determine the set of states of a specific key. + The method can be used to determine the set of states of a specific key. ## Examples - The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, then the background of a is changed. + The following example shows how to use the method to determine the state of a specific key. The key is passed to the method. If the method returns `true`, then the background of a is changed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Keyboard/Overview/Window1.xaml.cs" id="Snippetkeyeventargskeyboardiskeyup"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Keyboard/Overview/window1.xaml.vb" id="Snippetkeyeventargskeyboardiskeyup"::: @@ -1191,7 +1191,7 @@ ## Remarks This is an attached event. WPF implements attached events as routed events. Attached events are fundamentally a XAML language concept for referencing events that can be handled on objects that do not define that event, which WPF expands upon by also enabling the event to traverse a route. Attached events do not have a direct handling syntax in code; to attach handlers for a routed event in code, you use a designated Add*Handler method. For details, see [Attached Events Overview](/dotnet/framework/wpf/advanced/attached-events-overview). - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). If the event or the event is handled, keyboard focus does not change. @@ -1331,7 +1331,7 @@ If the event or the event is handled, keyboard focus does not change. - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). ## Routed Event Information @@ -1641,7 +1641,7 @@ If the event or the event is handled, keyboard focus does not change. - Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). + Keyboard focus refers to the object that is receiving keyboard input. The element with keyboard focus has set to `true`. There can be only one element with keyboard focus on the entire desktop. Logical focus refers to the object within a focus scope that has focus. For more information on focus, keyboard focus, and logical focus, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview) and [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview). ## Routed Event Information diff --git a/xml/System.Windows.Input/KeyboardDevice.xml b/xml/System.Windows.Input/KeyboardDevice.xml index 8c06bc741b4..a817dcdeede 100644 --- a/xml/System.Windows.Input/KeyboardDevice.xml +++ b/xml/System.Windows.Input/KeyboardDevice.xml @@ -24,17 +24,17 @@ Abstract class that represents a keyboard device. - supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. - - For keyboard related input, use the class. The class represents the keyboard to an application and provides methods, properties, and events that reflect the state of the keyboard. - - The class delegates to the appropriate . - - Each object represents one particular input device. For example, if there are two mice, there will be two objects. - + supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. + + For keyboard related input, use the class. The class represents the keyboard to an application and provides methods, properties, and events that reflect the state of the keyboard. + + The class delegates to the appropriate . + + Each object represents one particular input device. For example, if there are two mice, there will be two objects. + ]]> @@ -146,11 +146,11 @@ Clears focus. - method sets the focus to `null`. - + method sets the focus to `null`. + ]]> @@ -495,11 +495,11 @@ Gets the specified that input from this device is sent to. The element that receives input. - is the object that has keyboard focus. - + is the object that has keyboard focus. + ]]> diff --git a/xml/System.Windows.Input/KeyboardEventArgs.xml b/xml/System.Windows.Input/KeyboardEventArgs.xml index d14d1195d8a..4f3d0574e0c 100644 --- a/xml/System.Windows.Input/KeyboardEventArgs.xml +++ b/xml/System.Windows.Input/KeyboardEventArgs.xml @@ -24,11 +24,11 @@ Provides data for keyboard-related events. - . serves as the base class for the more specific and event data classes, which are used by existing WPF events such as and . - + . serves as the base class for the more specific and event data classes, which are used by existing WPF events such as and . + ]]> @@ -108,11 +108,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/KeyboardFocusChangedEventArgs.xml b/xml/System.Windows.Input/KeyboardFocusChangedEventArgs.xml index 575305db154..b3dd80418c6 100644 --- a/xml/System.Windows.Input/KeyboardFocusChangedEventArgs.xml +++ b/xml/System.Windows.Input/KeyboardFocusChangedEventArgs.xml @@ -24,39 +24,39 @@ Provides data for and routed events, as well as related attached and Preview events. - - -- - - This event data class is also used with the following routed events on base elements. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. - -- - -- - -- - -- - -- - -- - -- - -- - - The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - - If the event or the event is handled ( is set to `true` in the event data), keyboard focus will not change. - - If the event or the event is handled, keyboard focus will not change. - + + +- + + This event data class is also used with the following routed events on base elements. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. + +- + +- + +- + +- + +- + +- + +- + +- + + The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + + If the event or the event is handled ( is set to `true` in the event data), keyboard focus will not change. + + If the event or the event is handled, keyboard focus will not change. + ]]> @@ -134,11 +134,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/KeyboardFocusChangedEventHandler.xml b/xml/System.Windows.Input/KeyboardFocusChangedEventHandler.xml index b408f508567..45941178149 100644 --- a/xml/System.Windows.Input/KeyboardFocusChangedEventHandler.xml +++ b/xml/System.Windows.Input/KeyboardFocusChangedEventHandler.xml @@ -32,37 +32,37 @@ The event data. Represents the method that will handle the and routed events, as well as related attached and Preview events. - - -- - - This delegate is also used with the following routed events on base elements. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. - -- - -- - -- - -- - -- - -- - -- - -- - - The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - - If the event or the event is handled ( is set to `true` in the event data), keyboard focus will not change. - + + +- + + This delegate is also used with the following routed events on base elements. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. + +- + +- + +- + +- + +- + +- + +- + +- + + The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + + If the event or the event is handled ( is set to `true` in the event data), keyboard focus will not change. + ]]> diff --git a/xml/System.Windows.Input/KeyboardNavigation.xml b/xml/System.Windows.Input/KeyboardNavigation.xml index 22106fb8f21..06a9c302894 100644 --- a/xml/System.Windows.Input/KeyboardNavigation.xml +++ b/xml/System.Windows.Input/KeyboardNavigation.xml @@ -36,7 +36,7 @@ ## Examples - The following example creates a with a number of objects. The attached property is set to on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. + The following example creates a with a number of objects. The attached property is set to on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/FocusManager/FocusedElement/Window1.xaml" id="Snippetmarkupkeyboardnavigationtabnavigationxaml"::: @@ -911,7 +911,7 @@ ## Examples - The following example creates a with a number of objects. The attached property is set to on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. + The following example creates a with a number of objects. The attached property is set to on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. :::code language="xml" source="~/snippets/csharp/System.Windows.Input/FocusManager/FocusedElement/Window1.xaml" id="Snippetmarkupkeyboardnavigationtabnavigationxaml"::: diff --git a/xml/System.Windows.Input/KeyboardNavigationMode.xml b/xml/System.Windows.Input/KeyboardNavigationMode.xml index 0823fce423d..a198602fad6 100644 --- a/xml/System.Windows.Input/KeyboardNavigationMode.xml +++ b/xml/System.Windows.Input/KeyboardNavigationMode.xml @@ -23,16 +23,16 @@ Specifies the possible values for changes in focus when logical and directional navigation occurs. - with a number of objects. The attached property is set to Cycle on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/FocusManager/FocusedElement/Window1.xaml" id="Snippetmarkupkeyboardnavigationtabnavigationxaml"::: - + with a number of objects. The attached property is set to Cycle on the . This means that when focus is changed using the tab key within the , focus will move from each element and when the last element is reached focus will return to the first element. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/FocusManager/FocusedElement/Window1.xaml" id="Snippetmarkupkeyboardnavigationtabnavigationxaml"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/FocusManager/FocusedElement/Window1.xaml.cs" id="Snippetmarkupkeyboardnavigationtabnavigationcode"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/KeyboardNavigation/Overview/window1.xaml.vb" id="Snippetmarkupkeyboardnavigationtabnavigationcode"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/KeyboardNavigation/Overview/window1.xaml.vb" id="Snippetmarkupkeyboardnavigationtabnavigationcode"::: + ]]> diff --git a/xml/System.Windows.Input/Manipulation.xml b/xml/System.Windows.Input/Manipulation.xml index 7061312cd1c..edd3748e2bf 100644 --- a/xml/System.Windows.Input/Manipulation.xml +++ b/xml/System.Windows.Input/Manipulation.xml @@ -23,13 +23,13 @@ Contains methods to get and update information about a manipulation. - . However, the class defines static methods that you can use to interact with manipulations. - - For more information about manipulations, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). - + . However, the class defines static methods that you can use to interact with manipulations. + + For more information about manipulations, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + ]]> @@ -65,18 +65,18 @@ The object that provides the position of the input that creates or is added to a manipulation. Associates a object with the specified element. - - is . - - -or- - + is . + + -or- + is . The property on element is . @@ -110,11 +110,11 @@ The element on which to complete manipulation. Completes the active manipulation on the specified element. When called, manipulation input is no longer tracked and inertia on the specified element stops. - method is called, the event is raised. - + method is called, the event is raised. + ]]> diff --git a/xml/System.Windows.Input/ManipulationDelta.xml b/xml/System.Windows.Input/ManipulationDelta.xml index ba1081eb0cf..913d6c54662 100644 --- a/xml/System.Windows.Input/ManipulationDelta.xml +++ b/xml/System.Windows.Input/ManipulationDelta.xml @@ -26,14 +26,14 @@ class contains information about the changes in the position of a manipulation. Windows Presentation Foundation (WPF) interprets the changes as a , , or . When the event occurs on a , use the properties on a object to transform the object that should be manipulated. The class provides two properties of type : and . + The class contains information about the changes in the position of a manipulation. Windows Presentation Foundation (WPF) interprets the changes as a , , or . When the event occurs on a , use the properties on a object to transform the object that should be manipulated. The class provides two properties of type : and . For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). ## Examples - The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ManipulationDelta/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: @@ -111,7 +111,7 @@ and properties both report a resizing manipulation. The difference between the two is the way in which the value is reported. The property reports the resizing manipulation in device-independent units (1/96th inch per unit). The property reports the value as a multiplier. If is 0.5, the manipulation is interpreted as decreasing the size by 50 percent. If is 2, the manipulation is interpreted as increasing the size by 100 percent. + The and properties both report a resizing manipulation. The difference between the two is the way in which the value is reported. The property reports the resizing manipulation in device-independent units (1/96th inch per unit). The property reports the value as a multiplier. If is 0.5, the manipulation is interpreted as decreasing the size by 50 percent. If is 2, the manipulation is interpreted as increasing the size by 100 percent. ]]> @@ -157,7 +157,7 @@ ## Examples - The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ManipulationDelta/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: @@ -201,12 +201,12 @@ and properties both report a resizing manipulation. The difference between the two is the way in which the value is reported. The property reports the value as a multiplier. If is 0.5, the manipulation is interpreted as decreasing the size by 50 percent. If is 2, the manipulation is interpreted as increasing the size by 100 percent. The property reports the resizing manipulation in device-independent units (1/96th inch per unit). + The and properties both report a resizing manipulation. The difference between the two is the way in which the value is reported. The property reports the value as a multiplier. If is 0.5, the manipulation is interpreted as decreasing the size by 50 percent. If is 2, the manipulation is interpreted as increasing the size by 100 percent. The property reports the resizing manipulation in device-independent units (1/96th inch per unit). ## Examples - The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ManipulationDelta/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: @@ -255,7 +255,7 @@ ## Examples - The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). + The following example shows an event handler for the event. The example applies the , , and properties to move, resize, and rotate a . This example is part of a larger example in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/mainwindow.xaml.cs" id="Snippetmanipulationdelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ManipulationDelta/mainwindow.xaml.vb" id="Snippetmanipulationdelta"::: diff --git a/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml b/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml index 71722a03cfb..0e6b3c39eb5 100644 --- a/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationDeltaEventArgs.xml @@ -28,7 +28,7 @@ ## Remarks The class contains data about changes in the position of a manipulation. The property contains the changes that occurred since the last event occurred. The property contains the total changes that occurred for the current manipulation. You use one of those properties to transform the manipulated object. - You can end a manipulation by calling the method or force the manipulation into inertia by calling the method. + You can end a manipulation by calling the method or force the manipulation into inertia by calling the method. @@ -108,7 +108,7 @@ method to end the manipulation. For example, when an object reaches the edge of a window, you can call to prevent the object from going off the screen. + You can call the method to end the manipulation. For example, when an object reaches the edge of a window, you can call to prevent the object from going off the screen. @@ -157,7 +157,7 @@ property contains the total changes that occurred for the current manipulation. You can use to transform the manipulated object. + The property contains the total changes that occurred for the current manipulation. You can use to transform the manipulated object. ]]> @@ -423,12 +423,12 @@ method to indicate that an element has moved beyond a certain boundary. For example, if a user moves an element outside of the bounds of a , you can call this method to report that to the window. When you call , the event occurs. By default, the subscribes to the event to provide visual feedback to the user that a boundary has been reached. You can subscribe to to implement custom behavior. + Use the method to indicate that an element has moved beyond a certain boundary. For example, if a user moves an element outside of the bounds of a , you can call this method to report that to the window. When you call , the event occurs. By default, the subscribes to the event to provide visual feedback to the user that a boundary has been reached. You can subscribe to to implement custom behavior. ## Examples - The following example shows an event handler for the event that calls the method when the user moves the element over the edge of its container. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 5 with this code. + The following example shows an event handler for the event that calls the method when the user moves the element over the edge of its container. To test this example, follow the steps in [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application) and replace the code in step 5 with this code. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsManipulationEnabled/reportboundaryfeedbackexample.xaml.cs" id="Snippetreportboundaryfeedback"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ManipulationDelta/reportboundaryfeedbackexample.xaml.vb" id="Snippetreportboundaryfeedback"::: diff --git a/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml b/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml index e50dfd5a957..f7eef1183d4 100644 --- a/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml @@ -26,7 +26,7 @@ object to specify the inertial behavior of a manipulation. You can specify the inertial behavior for each type of manipulation separately by using the , , and properties. Each property is a type of object that represents the inertial behavior and in each case, you can specify the following: + You can use the object to specify the inertial behavior of a manipulation. You can specify the inertial behavior for each type of manipulation separately by using the , , and properties. Each property is a type of object that represents the inertial behavior and in each case, you can specify the following: - The initial velocity of the inertia when it begins. @@ -130,7 +130,7 @@ - Specify the desired deceleration of the inertia by setting the property. - You typically set either the or the , but not both. + You typically set either the or the , but not both. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -371,7 +371,7 @@ - Specify the desired deceleration of the inertia by setting the property. - You typically set either the or the , but not both. + You typically set either the or the , but not both. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -468,7 +468,7 @@ - Specify the desired deceleration of the inertia by setting the property. - You typically set either the or the , but not both. + You typically set either the or the , but not both. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). diff --git a/xml/System.Windows.Input/ManipulationPivot.xml b/xml/System.Windows.Input/ManipulationPivot.xml index 79c01c64c0a..b2c1eb05eaa 100644 --- a/xml/System.Windows.Input/ManipulationPivot.xml +++ b/xml/System.Windows.Input/ManipulationPivot.xml @@ -26,7 +26,7 @@ property is a . When you set in an event handler for the event, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. + The property is a . When you set in an event handler for the event, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. diff --git a/xml/System.Windows.Input/ManipulationStartingEventArgs.xml b/xml/System.Windows.Input/ManipulationStartingEventArgs.xml index be3b9db77aa..ce00a54ed9e 100644 --- a/xml/System.Windows.Input/ManipulationStartingEventArgs.xml +++ b/xml/System.Windows.Input/ManipulationStartingEventArgs.xml @@ -199,7 +199,7 @@ property. For example, you can make the manipulation positions relative to the parent of the element that receives the manipulation events. The event handler is the only place in which you can set the . + You can specify that the position should be relative to another element by setting the property. For example, you can make the manipulation positions relative to the parent of the element that receives the manipulation events. The event handler is the only place in which you can set the . For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). @@ -316,7 +316,7 @@ property, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. + When you set the property, the manipulation will contain rotation data when the user uses one finger during a manipulation. This is to simulate real-world situations where you can use one finger to rotate an object, such as a piece of paper on a table. If the is `null`, the user must use two fingers to cause rotation. For more information about manipulations, see the [Input Overview](/dotnet/framework/wpf/advanced/input-overview). For an example of an application that responds to manipulations, see [Walkthrough: Creating Your First Touch Application](/dotnet/framework/wpf/advanced/walkthrough-creating-your-first-touch-application). diff --git a/xml/System.Windows.Input/MediaCommands.xml b/xml/System.Windows.Input/MediaCommands.xml index 419d3f69595..86be0ba178a 100644 --- a/xml/System.Windows.Input/MediaCommands.xml +++ b/xml/System.Windows.Input/MediaCommands.xml @@ -27,9 +27,9 @@ class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command via a . For example, if the command is executed on a control (the command target), the logic which performs the command may not be provided by the command target, so the application writer will be responsible for writing the logic that determines how the command target will handle the command. + The commands in the class and commands in the other command library classes, such as and , are intended to represent a set of common commands that application programmers encounter frequently. The commands only represent the instance of the and not the implementation logic for the command. The implementation logic is bound to the command via a . For example, if the command is executed on a control (the command target), the logic which performs the command may not be provided by the command target, so the application writer will be responsible for writing the logic that determines how the command target will handle the command. - Many controls do provide implementation logic for many of the commands in the command library. For example, the class provides logic for the command, command, command, command, and command. + Many controls do provide implementation logic for many of the commands in the command library. For example, the class provides logic for the command, command, command, command, and command. For more information on commands and commanding see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). diff --git a/xml/System.Windows.Input/ModifierKeys.xml b/xml/System.Windows.Input/ModifierKeys.xml index 5a9bed1f1ef..ff3898ea9a2 100644 --- a/xml/System.Windows.Input/ModifierKeys.xml +++ b/xml/System.Windows.Input/ModifierKeys.xml @@ -42,7 +42,7 @@ ## Remarks The property on the class is the set of the modifier keys that are currently pressed. - Some APIs in Windows Presentation Foundation (WPF) that make use of the enumeration are the properties on the , , , and classes. + Some APIs in Windows Presentation Foundation (WPF) that make use of the enumeration are the properties on the , , , and classes. ## XAML Attribute Usage diff --git a/xml/System.Windows.Input/Mouse.xml b/xml/System.Windows.Input/Mouse.xml index 361b7d375f8..d91a4545157 100644 --- a/xml/System.Windows.Input/Mouse.xml +++ b/xml/System.Windows.Input/Mouse.xml @@ -562,7 +562,7 @@ If a is not specified, the default is . - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. @@ -609,14 +609,14 @@ If a is not specified, the default is . - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. ## Examples - The following example shows how to capture the mouse to a specific element by using the method. + The following example shows how to capture the mouse to a specific element by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/Capture/Window1.xaml.cs" id="Snippetmousecaptursamplecaptureelement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/Capture/window1.xaml.vb" id="Snippetmousecaptursamplecaptureelement"::: @@ -664,14 +664,14 @@ ## Remarks When an element captures the mouse, it receives mouse input whether the cursor is within its borders. - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. ## Examples - The following example shows how to capture the mouse to a specific element by using the method. + The following example shows how to capture the mouse to a specific element by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/Capture/Window1.xaml.cs" id="Snippetmousecaptursamplecaptureelement"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/Capture/window1.xaml.vb" id="Snippetmousecaptursamplecaptureelement"::: @@ -754,7 +754,7 @@ reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . + Controls can be composed of multiple elements. reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . Use the property on and to determine whether the mouse is over an element, which includes its visual child elements or control compositing elements. @@ -843,16 +843,16 @@ ## Remarks The position of the mouse pointer is calculated relative to the specified element with the upper-left corner of element being the point of origin, 0,0. - During drag-and-drop operations, the position of the mouse cannot be reliably determined through . This is because control of the mouse (possibly including capture) is held by the originating element of the drag until the drop is completed, with much of the behavior controlled by underlying Win32 calls. Try the following approaches instead: + During drag-and-drop operations, the position of the mouse cannot be reliably determined through . This is because control of the mouse (possibly including capture) is held by the originating element of the drag until the drop is completed, with much of the behavior controlled by underlying Win32 calls. Try the following approaches instead: -- Call the method of the that is passed to the drag events (, , ). +- Call the method of the that is passed to the drag events (, , ). - Call [GetCursorPos](/windows/win32/api/winuser/nf-winuser-getcursorpos), using P/Invoke. ## Examples - The following example shows how to use to determine the position of the mouse pointer. The position of the mouse pointer is stored in a structure. The and values of the object are displayed in a . + The following example shows how to use to determine the position of the mouse pointer. The position of the mouse pointer is stored in a structure. The and values of the object are displayed in a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetspositionmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetspositionmouse"::: @@ -891,7 +891,7 @@ This is an attached event. WPF implements attached events as routed events. Attached events are fundamentally a XAML language concept for referencing events that can be handled on objects that do not define that event, which WPF expands upon by also enabling the event to traverse a route. Attached events do not have a direct handling syntax in code; to attach handlers for a routed event in code, you use a designated Add*Handler method. For details, see [Attached Events Overview](/dotnet/framework/wpf/advanced/attached-events-overview). - Because of the bubbling routing, the actual element that has capture might be a child element, not necessarily the element where the event handler is actually attached. Check the in the event arguments to determine the actual element that has mouse capture. + Because of the bubbling routing, the actual element that has capture might be a child element, not necessarily the element where the event handler is actually attached. Check the in the event arguments to determine the actual element that has mouse capture. ## Routed Event Information @@ -973,7 +973,7 @@ is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. + The following example shows how to determine whether the left mouse button is pressed by checking if the state of the is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetsgetleftbuttonmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetsgetleftbuttonmouse"::: @@ -1012,7 +1012,7 @@ This is an attached event. WPF implements attached events as routed events. Attached events are fundamentally a XAML language concept for referencing events that can be handled on objects that do not define that event, which WPF expands upon by also enabling the event to traverse a route. Attached events do not have a direct handling syntax in code; to attach handlers for a routed event in code, you use a designated Add*Handler method. For details, see [Attached Events Overview](/dotnet/framework/wpf/advanced/attached-events-overview). - Because of the bubbling routing, the actual element that lost capture might be a child element, not necessarily the element where the event handler is actually attached. Check the in the event arguments to determine the actual element that lost capture. + Because of the bubbling routing, the actual element that lost capture might be a child element, not necessarily the element where the event handler is actually attached. Check the in the event arguments to determine the actual element that lost capture. ## Routed Event Information @@ -1094,7 +1094,7 @@ is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. + The following example shows how to determine whether the middle mouse button is pressed by checking if the state of the is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetsgetmiddlebuttonmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetsgetmiddlebuttonmouse"::: @@ -1133,7 +1133,7 @@ This is an attached event. WPF implements attached events as routed events. Attached events are fundamentally a XAML language concept for referencing events that can be handled on objects that do not define that event, which WPF expands upon by also enabling the event to traverse a route. Attached events do not have a direct handling syntax in code; to attach handlers for a routed event in code, you use a designated Add*Handler method. For details, see [Attached Events Overview](/dotnet/framework/wpf/advanced/attached-events-overview). - The Windows Presentation Foundation (WPF) framework builds on this attached event by surfacing it as two different common language runtime (CLR) events on and : and . These implementations handle the underlying event and read the arguments of the event to determine whether the left or right mouse button was involved. For a three-button mouse, there is no framework-level event support for the center button. You should use the event and check the state in the event arguments. + The Windows Presentation Foundation (WPF) framework builds on this attached event by surfacing it as two different common language runtime (CLR) events on and : and . These implementations handle the underlying event and read the arguments of the event to determine whether the left or right mouse button was involved. For a three-button mouse, there is no framework-level event support for the center button. You should use the event and check the state in the event arguments. > [!IMPORTANT] > A few derived classes that have control-like behavior, for example, , might have inherent class handling for mouse button events. The left mouse button down event is the most likely event to have class handling in a control. The class handling often marks the underlying class event as handled. Once the event is marked handled, other instance handlers that are attached to that element are not ordinarily raised. Any other class or instance handlers that are attached to elements in the bubbling direction towards the root in the UI tree are also not ordinarily raised. @@ -1142,7 +1142,7 @@ - Attach handlers for the event, which is not marked as handled by the controls. Notice that because this is a preview event, the route starts at the root and tunnels down to the control. -- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. +- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. For routed events that relate to the mouse, be careful about how or when you mark them handled. The difficulty in making the appropriate choices about whether parent elements should also be informed about any given mouse action is in fact why the WPF framework chose the model of having the underlying mouse routed event be surfaced as CLR events along the route. Similar issues exist with tunneling mouse events. Should you handle the event and not have it be handled by further children toward the source, and how would that affect compositing a control where the compositing pieces might have expected mouse behaviors? @@ -1659,16 +1659,16 @@ that is set to will be applied to the whole application. + The that is set to will be applied to the whole application. - To clear the override , set to `null`. + To clear the override , set to `null`. - Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. + Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. ## Examples - The following example shows an event handler for a that is used to toggle the scope of a cursor change between a single element and the entire application. If the control that raised the event is the `rbScopeElement` , a flag that denotes the scope of the cursor change is set and is set to `null`. If the control that raised the event is the `rbScopeApplication` , a flag that denotes the scope of the cursor change is set and is set to the property of the control named `DisplayArea`. + The following example shows an event handler for a that is used to toggle the scope of a cursor change between a single element and the entire application. If the control that raised the event is the `rbScopeElement` , a flag that denotes the scope of the cursor change is set and is set to `null`. If the control that raised the event is the `rbScopeApplication` , a flag that denotes the scope of the cursor change is set and is set to the property of the control named `DisplayArea`. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/ContextMenuClosing/Window1.xaml.cs" id="Snippetcursorssampleoverridecursor"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/ContextMenuClosing/Window1.xaml.vb" id="Snippetcursorssampleoverridecursor"::: @@ -2816,7 +2816,7 @@ is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. + The following example shows how to determine whether the right mouse button is pressed by checking if the state of the is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetsgetrightbuttonmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetsgetrightbuttonmouse"::: @@ -2963,7 +2963,7 @@ is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. + The following example shows how to determine whether the first extended mouse button is pressed by checking if the state of is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetsgetx1buttonmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetsgetx1buttonmouse"::: @@ -3003,7 +3003,7 @@ is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. + The following example shows how to determine whether the second extended mouse button is pressed by checking if the state of is equal to the enumeration value . If the button is pressed, a method is called which updates display elements in the sample. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Mouse/GetPosition/Window1.xaml.cs" id="Snippetmouserelatedsnippetsgetx2buttonmouse"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Mouse/GetPosition/window1.xaml.vb" id="Snippetmouserelatedsnippetsgetx2buttonmouse"::: diff --git a/xml/System.Windows.Input/MouseBinding.xml b/xml/System.Windows.Input/MouseBinding.xml index 714f00d2b28..7cb45dde3df 100644 --- a/xml/System.Windows.Input/MouseBinding.xml +++ b/xml/System.Windows.Input/MouseBinding.xml @@ -27,11 +27,11 @@ associates a with an implementation. is the primary implementation of the interface for the WPF commanding system. In general, when the is executed, the command is invoked, although the command behavior is further influenced by command-specific factors such as the value. For more information on commanding, see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). + A associates a with an implementation. is the primary implementation of the interface for the WPF commanding system. In general, when the is executed, the command is invoked, although the command behavior is further influenced by command-specific factors such as the value. For more information on commanding, see the [Commanding Overview](/dotnet/framework/wpf/advanced/commanding-overview). - When defining a in Extensible Application Markup Language (XAML), there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify mouse actions and modifiers as a single string; for example, "CTRL+LeftClick". The second way is to define the attribute of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the and the attributes are both set, the gesture is invalid. In general, it is recommended that you use only the attribute from XAML, even if you do not specify modifiers; this avoids ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. + When defining a in Extensible Application Markup Language (XAML), there are two ways to specify the . The first way to establish a in XAML is to define the attribute of the element, which enables a syntax to specify mouse actions and modifiers as a single string; for example, "CTRL+LeftClick". The second way is to define the attribute of the element. Both ways of setting the are equivalent and modify the same underlying object, but there will be a conflict if both are used. In the case when the and the attributes are both set, the gesture is invalid. In general, it is recommended that you use only the attribute from XAML, even if you do not specify modifiers; this avoids ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. - A can be defined on a specific object or at the class level by registering a on the class. The most typical way to define a is within the control template, setting the property in XAML by declaring one or more or elements. + A can be defined on a specific object or at the class level by registering a on the class. The most typical way to define a is within the control template, setting the property in XAML by declaring one or more or elements. @@ -127,7 +127,7 @@ with a using a . + The following example shows how to bind an with a using a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml.cs" id="Snippetmousebindingaddedcommand"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/InputBinding/.ctor/window1.xaml.vb" id="Snippetmousebindingaddedcommand"::: diff --git a/xml/System.Windows.Input/MouseButtonEventArgs.xml b/xml/System.Windows.Input/MouseButtonEventArgs.xml index 17836667888..b6b9e901120 100644 --- a/xml/System.Windows.Input/MouseButtonEventArgs.xml +++ b/xml/System.Windows.Input/MouseButtonEventArgs.xml @@ -284,7 +284,7 @@ is to determine whether a double mouse click has occurred. Some classes expose events for a double-click, such as the event on the class. When a double click event is not exposed on a class, a double click can be detected by using the property on the event data. + One use of is to determine whether a double mouse click has occurred. Some classes expose events for a double-click, such as the event on the class. When a double click event is not exposed on a class, a double click can be detected by using the property on the event data. @@ -339,7 +339,7 @@ and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as a and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> diff --git a/xml/System.Windows.Input/MouseDevice.xml b/xml/System.Windows.Input/MouseDevice.xml index 1fa62fe9a19..e4642bcef59 100644 --- a/xml/System.Windows.Input/MouseDevice.xml +++ b/xml/System.Windows.Input/MouseDevice.xml @@ -86,7 +86,7 @@ If a is not specified, the default is . - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. @@ -139,7 +139,7 @@ If a is not specified, the default is . - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. @@ -194,7 +194,7 @@ ## Remarks When an element captures the mouse, it receives mouse input whether or not the cursor is within its borders. - To release mouse capture, call passing `null` as the element to capture. + To release mouse capture, call passing `null` as the element to capture. If the mouse is captured when a or event is raised and the input is not going to the element underneath the mouse, and are raised first. This enables the captured element a chance to release capture before the and events are routed. @@ -286,7 +286,7 @@ ## Remarks The mouse is considered directly over an element if the mouse has been captured to that element. - Controls can be composed of multiple elements. reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . + Controls can be composed of multiple elements. reports the specific element in the composite control the mouse pointer is over and not the control itself. For example, depending on which part of a the pointer is over, the property could report the of the property or the . Use the property on and to determine whether the mouse is over an element, which includes its visual child elements or control compositing elements. @@ -595,11 +595,11 @@ that is set to will be applied to the whole application. + The that is set to will be applied to the whole application. - To clear the override , set to `null`. + To clear the override , set to `null`. - Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. + Setting to will force the mouse cursor not to be displayed, but mouse events are still processed. ]]> @@ -723,7 +723,7 @@ monitors layout changes and calls . There are cases in which the mouse input system must be forced to update for it to respond to changes. For example, you must resynchronize the mouse on a timer. + The monitors layout changes and calls . There are cases in which the mouse input system must be forced to update for it to respond to changes. For example, you must resynchronize the mouse on a timer. ]]> diff --git a/xml/System.Windows.Input/MouseEventArgs.xml b/xml/System.Windows.Input/MouseEventArgs.xml index bb3184050ce..ea552379a90 100644 --- a/xml/System.Windows.Input/MouseEventArgs.xml +++ b/xml/System.Windows.Input/MouseEventArgs.xml @@ -61,7 +61,7 @@ The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - Other than the properties that are relevant for all routed events, the most interesting properties of that you might use in a implementation are several properties that expose the current button state (such as ) and ). is useful particularly because you can check on it. + Other than the properties that are relevant for all routed events, the most interesting properties of that you might use in a implementation are several properties that expose the current button state (such as ) and ). is useful particularly because you can check on it. Note that events that specifically deal with mouse button events use a different event data class, . The mouse button properties are available on in case there are input modes or interactions that involve the buttons even if you are handling a non-button event. @@ -181,7 +181,7 @@ ## Remarks The point (0,0) is the upper-left corner of the frame of reference. - The static method can also be used to obtain the position of the mouse. + The static method can also be used to obtain the position of the mouse. ]]> @@ -223,7 +223,7 @@ and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as a and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> diff --git a/xml/System.Windows.Input/MouseEventHandler.xml b/xml/System.Windows.Input/MouseEventHandler.xml index 04271b9d515..e75f387d119 100644 --- a/xml/System.Windows.Input/MouseEventHandler.xml +++ b/xml/System.Windows.Input/MouseEventHandler.xml @@ -32,47 +32,47 @@ The event data. Represents the method that will handle mouse related routed events that do not specifically involve mouse buttons or the mouse wheel; for example, . - - -- - -- - -- - -- - -- - - This delegate is used with the following routed events. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. - -- - -- - -- - -- - -- - -- - -- - -- - - The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - - Other than the properties that are relevant for all routed events, the most interesting properties of that you might use in a implementation are several properties that expose the current button state, such as and . is useful particularly because you can check on it. - - Note that events that specifically deal with mouse button events use a different delegate, . The mouse button properties are available on in case there are input modes or interactions that involve the buttons even if you are handling a non-button event. - + + +- + +- + +- + +- + +- + + This delegate is used with the following routed events. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF. + +- + +- + +- + +- + +- + +- + +- + +- + + The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + + Other than the properties that are relevant for all routed events, the most interesting properties of that you might use in a implementation are several properties that expose the current button state, such as and . is useful particularly because you can check on it. + + Note that events that specifically deal with mouse button events use a different delegate, . The mouse button properties are available on in case there are input modes or interactions that involve the buttons even if you are handling a non-button event. + ]]> diff --git a/xml/System.Windows.Input/MouseGesture.xml b/xml/System.Windows.Input/MouseGesture.xml index e9d866effed..0f825207981 100644 --- a/xml/System.Windows.Input/MouseGesture.xml +++ b/xml/System.Windows.Input/MouseGesture.xml @@ -41,7 +41,7 @@ A can be bound to a (or other implementations) through a so that the command is invoked when the occurs. - For XAML attribute usages, the property that is generally set in XAML is , in cases where the gesture can represent both a mouse action and one or more modifier key. You can also set the property to be just a mouse action. In general, it is recommended that you use only the attribute from XAML, rather than setting , even if you do not specify modifiers. This will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. + For XAML attribute usages, the property that is generally set in XAML is , in cases where the gesture can represent both a mouse action and one or more modifier key. You can also set the property to be just a mouse action. In general, it is recommended that you use only the attribute from XAML, rather than setting , even if you do not specify modifiers. This will avoid ambiguity, provides the most streamlined syntax, and provides the most straightforward representation for serialization. XAML object element usages are possible but uncommon, because you can ordinarily set the property of inline without the use of property element syntax. @@ -67,7 +67,7 @@ ## Examples - The following example shows to create a and associate it with a through a . When the mouse wheel is clicked while the key is pressed, the is invoked. + The following example shows to create a and associate it with a through a . When the mouse wheel is clicked while the key is pressed, the is invoked. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml" id="Snippetmousebindingmousegesturexaml"::: @@ -250,7 +250,7 @@ matches the input associated with an instance of an . A event handler compares the event data with the by using the method. + The following example shows how to test whether a matches the input associated with an instance of an . A event handler compares the event data with the by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/InputBinding/.ctor/Window1.xaml.cs" id="Snippetkeydownhandlermousegesturematches"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/InputBinding/.ctor/window1.xaml.vb" id="Snippetkeydownhandlermousegesturematches"::: diff --git a/xml/System.Windows.Input/MouseWheelEventArgs.xml b/xml/System.Windows.Input/MouseWheelEventArgs.xml index 371c99dc88d..bf300a0e695 100644 --- a/xml/System.Windows.Input/MouseWheelEventArgs.xml +++ b/xml/System.Windows.Input/MouseWheelEventArgs.xml @@ -48,7 +48,7 @@ ## Examples - The following example moves a up if the mouse wheel is positive and moves the down if the mouse wheel is negative. The is attached to a . + The following example moves a up if the mouse wheel is positive and moves the down if the mouse wheel is negative. The is attached to a . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsMouseCaptured/Window1.xaml.cs" id="Snippetmousewheeldelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/IsMouseCaptured/window1.xaml.vb" id="Snippetmousewheeldelta"::: @@ -132,7 +132,7 @@ ## Examples - The following example moves a up if the mouse wheel is positive and moves the down if the mouse wheel is negative. The is attached to a . + The following example moves a up if the mouse wheel is positive and moves the down if the mouse wheel is negative. The is attached to a . :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsMouseCaptured/Window1.xaml.cs" id="Snippetmousewheeldelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/IsMouseCaptured/window1.xaml.vb" id="Snippetmousewheeldelta"::: @@ -177,7 +177,7 @@ and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as a and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> diff --git a/xml/System.Windows.Input/MouseWheelEventHandler.xml b/xml/System.Windows.Input/MouseWheelEventHandler.xml index 3d288e10a0c..4a255bd6467 100644 --- a/xml/System.Windows.Input/MouseWheelEventHandler.xml +++ b/xml/System.Windows.Input/MouseWheelEventHandler.xml @@ -58,7 +58,7 @@ ## Examples - The following example moves a , which is attached to a , upward if the mouse wheel is positive and moves the downward if the mouse wheel is negative. + The following example moves a , which is attached to a , upward if the mouse wheel is positive and moves the downward if the mouse wheel is negative. :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/IsMouseCaptured/Window1.xaml.cs" id="Snippetmousewheeldelta"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/IsMouseCaptured/window1.xaml.vb" id="Snippetmousewheeldelta"::: diff --git a/xml/System.Windows.Input/NavigationCommands.xml b/xml/System.Windows.Input/NavigationCommands.xml index bd6b6a79daf..596cf995e3a 100644 --- a/xml/System.Windows.Input/NavigationCommands.xml +++ b/xml/System.Windows.Input/NavigationCommands.xml @@ -93,7 +93,7 @@ ## Remarks This command indicates the intention to navigate back to the previous page in the journal. - and implement support for responding to the , although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the , although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -105,7 +105,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating the back, if there are journal entries on the back stack. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating the back, if there are journal entries on the back stack. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseBack.xaml" id="Snippetbrowsebackmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseBack.xaml" id="Snippetbrowsebackmarkup2"::: @@ -174,7 +174,7 @@ ## Remarks This command indicates the intention to navigate forward the next page in the journal. - and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -186,7 +186,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating the forward, if there are journal entries on the forward stack. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating the forward, if there are journal entries on the forward stack. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseForward.xaml" id="Snippetbrowseforwardmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseForward.xaml" id="Snippetbrowseforwardmarkup2"::: @@ -255,7 +255,7 @@ ## Remarks This command indicates the intention to navigate home. - There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. + There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. ## XAML Attribute Usage @@ -267,7 +267,7 @@ ## Examples - The following example shows how to implement code that responds to the command in conjunction with a . + The following example shows how to implement code that responds to the command in conjunction with a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseHome.xaml" id="Snippetbrowsehomemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseHome.xaml" id="Snippetbrowsehomemarkup2"::: @@ -339,7 +339,7 @@ ## Remarks This command indicates the intention to stop the browser loading. - and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -351,7 +351,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by stopping the current navigation. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by stopping the current navigation. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseStop.xaml" id="Snippetbrowsestopmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/BrowseStop.xaml" id="Snippetbrowsestopmarkup2"::: @@ -420,7 +420,7 @@ ## Remarks This command indicates the intention to decrease the zoom. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -432,7 +432,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by decreasing the zoom percentage. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by decreasing the zoom percentage. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/DecreaseZoom.xaml" id="Snippetdecreasezoommarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/DecreaseZoom.xaml" id="Snippetdecreasezoommarkup2"::: @@ -502,7 +502,7 @@ ## Remarks This command indicates the intention to manage and navigate to favorites. - There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. + There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. ## XAML Attribute Usage @@ -514,7 +514,7 @@ ## Examples - The following example shows how to implement code that responds to the command in conjunction with a . + The following example shows how to implement code that responds to the command in conjunction with a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Favorites.xaml" id="Snippetfavoritesmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Favorites.xaml" id="Snippetfavoritesmarkup2"::: @@ -585,7 +585,7 @@ ## Remarks This command indicates the intention to go to the first page. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -597,7 +597,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the first page. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the first page. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/FirstPage.xaml" id="Snippetfirstpagemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/FirstPage.xaml" id="Snippetfirstpagemarkup2"::: @@ -667,7 +667,7 @@ ## Remarks This command indicates the intention to change the zoom. - and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -679,7 +679,7 @@ ## Examples - The following example shows how to use the command in conjunction with a . The provides an implementation that responds to the command by going to the page specified by the text value of a control. + The following example shows how to use the command in conjunction with a . The provides an implementation that responds to the command by going to the page specified by the text value of a control. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/GoToPage.xaml" id="Snippetgotopagemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/GoToPage.xaml" id="Snippetgotopagemarkup2"::: @@ -749,7 +749,7 @@ ## Remarks This command indicates the intention to increase the zoom. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -761,7 +761,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by decreasing the zoom percentage. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by decreasing the zoom percentage. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/IncreaseZoom.xaml" id="Snippetincreasezoommarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/IncreaseZoom.xaml" id="Snippetincreasezoommarkup2"::: @@ -831,7 +831,7 @@ ## Remarks This command indicates the intention to go to the last page. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -843,7 +843,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the last page. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the last page. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/LastPage.xaml" id="Snippetlastpagemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/LastPage.xaml" id="Snippetlastpagemarkup2"::: @@ -913,7 +913,7 @@ ## Remarks This command indicates the intention to navigate the journal. - and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -925,7 +925,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating to the specified journal entry on either the forward or back stacks of the . The journal entries are provided by the to the top-level `Navigate Journal` . Each journal entry is bound to a child that uses the command. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by navigating to the specified journal entry on either the forward or back stacks of the . The journal entries are provided by the to the top-level `Navigate Journal` . Each journal entry is bound to a child that uses the command. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/NavigateJournal.xaml" id="Snippetnavigatejournalmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/NavigateJournal.xaml" id="Snippetnavigatejournalmarkup2"::: @@ -994,7 +994,7 @@ ## Remarks This command indicates the intention to go to the next page. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -1006,7 +1006,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the next page. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the next page. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/NextPage.xaml" id="Snippetnextpagemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/NextPage.xaml" id="Snippetnextpagemarkup2"::: @@ -1076,7 +1076,7 @@ ## Remarks This command indicates the intention to go to the previous page. - , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + , , , and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -1088,7 +1088,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the previous page. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by going to the previous page. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/PreviousPage.xaml" id="Snippetpreviouspagemarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/PreviousPage.xaml" id="Snippetpreviouspagemarkup2"::: @@ -1158,7 +1158,7 @@ ## Remarks This command indicates the intention to refresh the current page. - and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. + and implement support for responding to the command, although you are not required to use it; in many cases the implementation in response to that command is the responsibility of the application writer. ## XAML Attribute Usage @@ -1170,7 +1170,7 @@ ## Examples - The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by reloading the current content. + The following example shows how to use in conjunction with a . The provides an implementation that responds to the command by reloading the current content. :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Refresh.xaml" id="Snippetrefreshmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Refresh.xaml" id="Snippetrefreshmarkup2"::: @@ -1239,7 +1239,7 @@ ## Remarks This command indicates the intention to search. - There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. + There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. ## XAML Attribute Usage @@ -1251,7 +1251,7 @@ ## Examples - The following example shows how to implement code that responds to the command in conjunction with a . + The following example shows how to implement code that responds to the command in conjunction with a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Search.xaml" id="Snippetsearchmarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Search.xaml" id="Snippetsearchmarkup2"::: @@ -1324,7 +1324,7 @@ ## Remarks This command indicates the intention to set the zoom level. - There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. + There is no implementation for responding to the command on any given WPF class. As such, you need to provide an appropriate implementation, which is shown in the example. ## XAML Attribute Usage @@ -1336,7 +1336,7 @@ ## Examples - The following example shows how to implement code that responds to the command in conjunction with a . + The following example shows how to implement code that responds to the command in conjunction with a . :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Zoom.xaml" id="Snippetzoommarkup1"::: :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/NavigationCommands/BrowseBack/Zoom.xaml" id="Snippetzoommarkup2"::: diff --git a/xml/System.Windows.Input/QueryCursorEventArgs.xml b/xml/System.Windows.Input/QueryCursorEventArgs.xml index 197543e39c1..fe25478ebf7 100644 --- a/xml/System.Windows.Input/QueryCursorEventArgs.xml +++ b/xml/System.Windows.Input/QueryCursorEventArgs.xml @@ -24,11 +24,11 @@ Provides data for the event. - and objects whenever the mouse pointer moves to a new location. - + and objects whenever the mouse pointer moves to a new location. + ]]> @@ -193,11 +193,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/RoutedCommand.xml b/xml/System.Windows.Input/RoutedCommand.xml index 882ea0637fa..ff38ce74582 100644 --- a/xml/System.Windows.Input/RoutedCommand.xml +++ b/xml/System.Windows.Input/RoutedCommand.xml @@ -50,9 +50,9 @@ ## Remarks - The and methods on a do not contain the application logic for the command as is the case with a typical , but rather, these methods raise events that traverse the element tree looking for an object with a . The event handlers attached to the contain the command logic. + The and methods on a do not contain the application logic for the command as is the case with a typical , but rather, these methods raise events that traverse the element tree looking for an object with a . The event handlers attached to the contain the command logic. - The method raises the and events. The method raises the and events. + The method raises the and events. The method raises the and events. ## XAML attribute usage @@ -257,18 +257,18 @@ can execute on the current command target is not contained in the methods, rather raises the and the events which tunnel and bubble through element tree looking for a object with a . If a for that is found, then the attached to is called. These handlers supply the programming logic for determining if the can execute or not. + The actual logic that determines if a can execute on the current command target is not contained in the methods, rather raises the and the events which tunnel and bubble through element tree looking for a object with a . If a for that is found, then the attached to is called. These handlers supply the programming logic for determining if the can execute or not. - The and events are raised on the . If the is not set on the , the and events are raised on the element with keyboard focus. + The and events are raised on the . If the is not set on the , the and events are raised on the element with keyboard focus. ## Examples The following example is a event handler from a custom implementation of . - `this.Command` in this example is the property on the . If the command is not `null`, the command is cast to a . If the command is a , then the method is called passing the and the . If command is not a , it is cast to an and the method is called passing the . + `this.Command` in this example is the property on the . If the command is not `null`, the command is cast to a . If the command is a , then the method is called passing the and the . If command is not a , it is cast to an and the method is called passing the . - If the method returns `true`, then the control is enabled; otherwise, the control is disable. + If the method returns `true`, then the control is enabled; otherwise, the control is disable. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/RoutedCommand/CanExecute/CommandSlider.cs" id="Snippetimplementicommandcanexecutechanged"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/RoutedCommand/CanExecute/commandslider.vb" id="Snippetimplementicommandcanexecutechanged"::: @@ -311,18 +311,18 @@ listens for the event, which is raised by the . The event is raised whenever conditions are met that may change the whether the command should execute, such as a change in keyboard focus. When the command receives the event, it raises the event. Generally, the command source will listen for this event and query the by way of the method. Most command sources will disable themselves if the command cannot be executed, as part of their command binding. An example of this is when a grays itself out when the command cannot be executed. + The listens for the event, which is raised by the . The event is raised whenever conditions are met that may change the whether the command should execute, such as a change in keyboard focus. When the command receives the event, it raises the event. Generally, the command source will listen for this event and query the by way of the method. Most command sources will disable themselves if the command cannot be executed, as part of their command binding. An example of this is when a grays itself out when the command cannot be executed. - In some situations, the is unaware of a change in conditions that alters the ability of a command to execute. In these cases, you can force the to raises the event by calling the method, this will in turn cause the to raise the event. + In some situations, the is unaware of a change in conditions that alters the ability of a command to execute. In these cases, you can force the to raises the event by calling the method, this will in turn cause the to raise the event. ## Examples The following example is a event handler from a custom implementation of . - `this.Command` in this example is the property on the . If the command is not `null`, the command is cast to a . If the command is a , then the method is called passing the and the . If command is not a , it is cast to an and the method is called passing the . + `this.Command` in this example is the property on the . If the command is not `null`, the command is cast to a . If the command is a , then the method is called passing the and the . If command is not a , it is cast to an and the method is called passing the . - If the method returns `true`, then the control is enabled; otherwise, the control is disabled. + If the method returns `true`, then the control is enabled; otherwise, the control is disabled. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/RoutedCommand/CanExecute/CommandSlider.cs" id="Snippetimplementicommandcanexecutechanged"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/RoutedCommand/CanExecute/commandslider.vb" id="Snippetimplementicommandcanexecutechanged"::: @@ -372,16 +372,16 @@ is not contained in the methods. raises the and events, which tunnel and bubble through the element tree looking for an object with a . If a for that is found, then the attached to is called. These handlers supply the programming logic that performs the . + The actual logic that executes the is not contained in the methods. raises the and events, which tunnel and bubble through the element tree looking for an object with a . If a for that is found, then the attached to is called. These handlers supply the programming logic that performs the . - The and events are raised on the . If the is not set on the , the and events are raised on the element with keyboard focus. + The and events are raised on the . If the is not set on the , the and events are raised on the element with keyboard focus. ## Examples The following example is from a custom implementation of sample. - `this.Command` in this example is the Command property on the . If the command is not null, the command is cast to a . If it is a , then the method is called passing the and the . If the command is not a , it is cast to an and the method is called passing the . + `this.Command` in this example is the Command property on the . If the command is not null, the command is cast to a . If it is a , then the method is called passing the and the . If the command is not a , it is cast to an and the method is called passing the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/RoutedCommand/CanExecute/CommandSlider.cs" id="Snippetimplementicommandexecute"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/RoutedCommand/CanExecute/commandslider.vb" id="Snippetimplementicommandexecute"::: @@ -608,7 +608,7 @@ ## Examples See Also - + ]]> diff --git a/xml/System.Windows.Input/RoutedUICommand.xml b/xml/System.Windows.Input/RoutedUICommand.xml index ca6c54d3da7..ec581ae8b11 100644 --- a/xml/System.Windows.Input/RoutedUICommand.xml +++ b/xml/System.Windows.Input/RoutedUICommand.xml @@ -40,9 +40,9 @@ The difference between a and is that includes a property. - The and methods on a do not contain the command logic for the command, as is the case with a typical . These methods raise events that traverse the element tree looking for an object with a . The event handlers attached to the contain the command logic. + The and methods on a do not contain the command logic for the command, as is the case with a typical . These methods raise events that traverse the element tree looking for an object with a . The event handlers attached to the contain the command logic. - The method raises the and events. The method raises the and events. + The method raises the and events. The method raises the and events. ## XAML attribute usage diff --git a/xml/System.Windows.Input/Stylus.xml b/xml/System.Windows.Input/Stylus.xml index ef1b49753ef..bdcaf3cffba 100644 --- a/xml/System.Windows.Input/Stylus.xml +++ b/xml/System.Windows.Input/Stylus.xml @@ -834,9 +834,9 @@ method to ensure that `element` receives stylus events even when the cursor goes out of the elements' bounds. To release the stylus, call with the set to . + Use the method to ensure that `element` receives stylus events even when the cursor goes out of the elements' bounds. To release the stylus, call with the set to . - The method returns `false` if `element` is not visible or enabled. + The method returns `false` if `element` is not visible or enabled. @@ -887,9 +887,9 @@ method to ensure that `element` receives stylus events even when the cursor goes out of the elements' bounds. To release the stylus, call with the set to . + Use the method to ensure that `element` receives stylus events even when the cursor goes out of the elements' bounds. To release the stylus, call with the set to . - The method returns `false` if `element` is not visible or enabled. + The method returns `false` if `element` is not visible or enabled. @@ -4197,12 +4197,12 @@ method might return an element that has moved out from under the cursor. Call to be sure that returns the proper element. + Applications may need to determine the element on which the cursor is located. If the application uses animation, the method might return an element that has moved out from under the cursor. Call to be sure that returns the proper element. ## Examples - The following example demonstrates how to get the element that is under the cursor. Calling ensures that returns the correct element. + The following example demonstrates how to get the element that is under the cursor. Calling ensures that returns the correct element. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Stylus/Overview/Window2.xaml.cs" id="Snippet24"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Stylus/Overview/Window2.xaml.vb" id="Snippet24"::: diff --git a/xml/System.Windows.Input/StylusButton.xml b/xml/System.Windows.Input/StylusButton.xml index 176dd5951df..d14601e294f 100644 --- a/xml/System.Windows.Input/StylusButton.xml +++ b/xml/System.Windows.Input/StylusButton.xml @@ -246,7 +246,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusButton/Overview/Window1.xaml.cs" id="Snippet28"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusButton/Overview/Window1.xaml.vb" id="Snippet28"::: diff --git a/xml/System.Windows.Input/StylusButtonEventArgs.xml b/xml/System.Windows.Input/StylusButtonEventArgs.xml index 9593cad3c4e..44627fe75bf 100644 --- a/xml/System.Windows.Input/StylusButtonEventArgs.xml +++ b/xml/System.Windows.Input/StylusButtonEventArgs.xml @@ -97,11 +97,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/StylusDevice.xml b/xml/System.Windows.Input/StylusDevice.xml index 6056a0d2fe7..46f53454754 100644 --- a/xml/System.Windows.Input/StylusDevice.xml +++ b/xml/System.Windows.Input/StylusDevice.xml @@ -131,7 +131,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusButton/Overview/Window1.xaml.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusButton/Overview/Window1.xaml.vb" id="Snippet3"::: @@ -181,7 +181,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusButton/Overview/Window1.xaml.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusButton/Overview/Window1.xaml.vb" id="Snippet5"::: @@ -312,7 +312,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusButton/Overview/Window1.xaml.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusButton/Overview/Window1.xaml.vb" id="Snippet8"::: @@ -413,7 +413,7 @@ property of the used by the method. Use the method to get a before calling the method. + `subsetToReformatTo` must be compatible with the property of the used by the method. Use the method to get a before calling the method. @@ -731,12 +731,12 @@ method might return an element that has moved out from under the cursor. Call to be sure that returns the proper element. + Applications may need to locate the element that the cursor is positioned over. If the application uses animation, the method might return an element that has moved out from under the cursor. Call to be sure that returns the proper element. ## Examples - The following example demonstrates how to return an element that is under the cursor. Calling ensures that returns the correct element. + The following example demonstrates how to return an element that is under the cursor. Calling ensures that returns the correct element. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Stylus/Overview/Window2.xaml.cs" id="Snippet24"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Stylus/Overview/Window2.xaml.vb" id="Snippet24"::: @@ -862,7 +862,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusButton/Overview/Window1.xaml.cs" id="Snippet17"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusButton/Overview/Window1.xaml.vb" id="Snippet17"::: diff --git a/xml/System.Windows.Input/StylusDownEventArgs.xml b/xml/System.Windows.Input/StylusDownEventArgs.xml index 800c9e904e0..e2becb4eacf 100644 --- a/xml/System.Windows.Input/StylusDownEventArgs.xml +++ b/xml/System.Windows.Input/StylusDownEventArgs.xml @@ -95,11 +95,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/StylusEventArgs.xml b/xml/System.Windows.Input/StylusEventArgs.xml index bd448c3ceae..a9a83dcb035 100644 --- a/xml/System.Windows.Input/StylusEventArgs.xml +++ b/xml/System.Windows.Input/StylusEventArgs.xml @@ -207,10 +207,10 @@ property of the from the method. Use the method to get a before calling the method. + `subsetToReformatTo` must be compatible with the property of the from the method. Use the method to get a before calling the method. > [!NOTE] -> uses constraints from the in , even if the constraints in `subsetToReformatTo` are different. For example, if `subsetToReformatTo` uses values of 0 and 1023 but uses values of 0 and 255, returns a containing the values 0 and 255. +> uses constraints from the in , even if the constraints in `subsetToReformatTo` are different. For example, if `subsetToReformatTo` uses values of 0 and 1023 but uses values of 0 and 255, returns a containing the values 0 and 255. ]]> @@ -313,7 +313,7 @@ and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as a and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> diff --git a/xml/System.Windows.Input/StylusPoint.xml b/xml/System.Windows.Input/StylusPoint.xml index 226a514a113..d53786427e8 100644 --- a/xml/System.Windows.Input/StylusPoint.xml +++ b/xml/System.Windows.Input/StylusPoint.xml @@ -31,7 +31,7 @@ collects data when a user inputs ink using the digitizer. Because the information that a digitizer reports differs depending on the manufacturer, the properties within a can vary. To determine whether a property is in the , call the method. The property contains a that specifies which properties are in the . All objects contain properties that specify the (x, y) coordinates, as well as the pressure. + A collects data when a user inputs ink using the digitizer. Because the information that a digitizer reports differs depending on the manufacturer, the properties within a can vary. To determine whether a property is in the , call the method. The property contains a that specifies which properties are in the . All objects contain properties that specify the (x, y) coordinates, as well as the pressure. @@ -304,7 +304,7 @@ objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. + The following example checks two objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet6"::: @@ -353,7 +353,7 @@ objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. + The following example checks two objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet6"::: @@ -401,7 +401,7 @@ objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. + The following example checks two objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet6"::: @@ -477,7 +477,7 @@ contains the specified property, call the before calling either the method or the method. + To check whether the contains the specified property, call the before calling either the method or the method. @@ -528,7 +528,7 @@ contains the specified property, call the before calling either the method or the method. + To check whether the contains the specified property, call the before calling either the method or the method. @@ -658,10 +658,10 @@ if the objects are equal; otherwise, . - + ## Examples - The following example checks two objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. + The following example checks two objects for equality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet6"::: @@ -746,10 +746,10 @@ if the specified objects are unequal; otherwise, . - + ## Examples - The following example demonstrates how to check two objects for inequality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. + The following example demonstrates how to check two objects for inequality. Because the , , and properties on `point1` and `point2` are set to the same value, the "The two StylusPoint objects are equal." Message appears. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet6"::: @@ -848,7 +848,7 @@ contains the specified property, call the before calling either the method or the method. + To check whether the contains the specified property, call the before calling either the method or the method. diff --git a/xml/System.Windows.Input/StylusPointCollection.xml b/xml/System.Windows.Input/StylusPointCollection.xml index 75c6753fdd6..4f9b7d1ab8d 100644 --- a/xml/System.Windows.Input/StylusPointCollection.xml +++ b/xml/System.Windows.Input/StylusPointCollection.xml @@ -35,7 +35,7 @@ ## Examples - The following example overrides the method to draw a circle at each comprising a . If the property is set to `true`, the method returns the stylus points. Otherwise, the property returns the stylus points. + The following example overrides the method to draw a circle at each comprising a . If the property is set to `true`, the method returns the stylus points. Otherwise, the property returns the stylus points. :::code language="csharp" source="~/snippets/csharp/System.Windows.Ink/Stroke/.ctor/MyStroke.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Ink/Stroke/.ctor/MyStroke.vb" id="Snippet23"::: @@ -79,7 +79,7 @@ objects in the method of a custom control. The example creates a by specifying the and the initial size of the . + The following example collects objects in the method of a custom control. The example creates a by specifying the and the initial size of the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet19"::: @@ -206,12 +206,12 @@ constructor to create a new , you specify it's `initialCapacity`. However, you can add more objects by calling the method. + When you use the constructor to create a new , you specify it's `initialCapacity`. However, you can add more objects by calling the method. ## Examples - The following example collects objects in the method of a custom control. The example creates a by specifying both the and the initial size of the . + The following example collects objects in the method of a custom control. The example creates a by specifying both the and the initial size of the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet19"::: @@ -257,7 +257,7 @@ ## Examples - The following example collects objects in the method of a custom control. The example creates a by specifying the and the initial size of the . + The following example collects objects in the method of a custom control. The example creates a by specifying the and the initial size of the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet19"::: @@ -300,12 +300,12 @@ constructor to create a new , the is created with the capacity to hold the specified number of objects. You can add more objects than `initialCapacity` by calling the method. + When you use the constructor to create a new , the is created with the capacity to hold the specified number of objects. You can add more objects than `initialCapacity` by calling the method. ## Examples - The following example collects objects in the method of a custom control. The example creates a by specifying the and the initial size of the . + The following example collects objects in the method of a custom control. The example creates a by specifying the and the initial size of the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet19"::: @@ -351,7 +351,7 @@ objects in the method of a custom control. + The following example collects objects in the method of a custom control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet19"::: @@ -657,12 +657,12 @@ which describes a subset of values belonging to the property. Use the method to get a that intersects the of the current . + `subsetToReformatTo` is a which describes a subset of values belonging to the property. Use the method to get a that intersects the of the current . - The method returns a that contains the same objects as those belonging to the current . The objects in the new uses `subsetToReformatTo` as the . + The method returns a that contains the same objects as those belonging to the current . The objects in the new uses `subsetToReformatTo` as the . > [!NOTE] -> uses the constraints from the of the property, even if the constraints in `subsetToReformatTo` are different. For example, if `subsetToReformatTo` uses the values 0 and 1023 for whereas uses the values 0 and 255. returns a using the values, 0 and 255. +> uses the constraints from the of the property, even if the constraints in `subsetToReformatTo` are different. For example, if `subsetToReformatTo` uses the values 0 and 1023 for whereas uses the values 0 and 255. returns a using the values, 0 and 255. diff --git a/xml/System.Windows.Input/StylusPointDescription.xml b/xml/System.Windows.Input/StylusPointDescription.xml index a89eb78aa91..731f7514414 100644 --- a/xml/System.Windows.Input/StylusPointDescription.xml +++ b/xml/System.Windows.Input/StylusPointDescription.xml @@ -24,23 +24,23 @@ Specifies the properties that are in a . - specifies which properties are associated with a . For each property in a , the contains a object which specifies constraints such as the minimum and maximum values of the property. Use the and methods to check for these properties in the . - - All objects in a must share the same . If you try to add a to a that has a different , an exception will be thrown. - - - -## Examples - The following example gets the for a and gets the information for each in the . - + specifies which properties are associated with a . For each property in a , the contains a object which specifies constraints such as the minimum and maximum values of the property. Use the and methods to check for these properties in the . + + All objects in a must share the same . If you try to add a to a that has a different , an exception will be thrown. + + + +## Examples + The following example gets the for a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -77,19 +77,19 @@ Initializes a new instance of the class. - that contains information for the properties , , and . - - - -## Examples - The following example creates a object and uses it to create a . - + that contains information for the properties , , and . + + + +## Examples + The following example creates a object and uses it to create a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet5"::: + ]]> @@ -121,19 +121,19 @@ A generic IEnumerable of type that specifies the properties in the . Initializes a new instance of the class with the specified objects. - objects for the properties, , , and . - - - -## Examples - The following example creates an object and uses it to create a . - + objects for the properties, , , and . + + + +## Examples + The following example creates an object and uses it to create a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet5"::: + ]]> @@ -172,21 +172,21 @@ if the objects are identical; otherwise, . - objects are compatible if they contain the same objects in the same order. - - - -## Examples - The following example checks whether two objects are compatible. - + objects are compatible if they contain the same objects in the same order. + + + +## Examples + The following example checks whether two objects are compatible. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet22"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet22"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet22"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet23"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet23"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet23"::: + ]]> @@ -228,15 +228,15 @@ ## Remarks -`StylusPointDescription1` and `stylusPointDescriptionPreserveInfo` may have a common property, yet the constraints specified in their respective objects differ. If the constraints differ, the method uses the from `stylusPointDescriptionPreserveInfo`. +`StylusPointDescription1` and `stylusPointDescriptionPreserveInfo` may have a common property, yet the constraints specified in their respective objects differ. If the constraints differ, the method uses the from `stylusPointDescriptionPreserveInfo`. ## Examples The following example demonstrates how to find the common from two different objects. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet26"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet26"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet26"::: + ]]> @@ -272,14 +272,14 @@ The following example demonstrates how to find the common Gets the for the specified property. The for the specified . - . This example assumes that the event has been connected to the event handler below. - + . This example assumes that the event has been connected to the event handler below. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet21"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet21"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet21"::: + ]]> @@ -312,16 +312,16 @@ The following example demonstrates how to find the common Gets all the properties of the . A collection that contains all of the objects in the . - for a together with the information for each in the . - + for a together with the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -358,14 +358,14 @@ The following example demonstrates how to find the common if the has the specified ; otherwise, . - . This example assumes that the event has been connected to the event handler. - + . This example assumes that the event has been connected to the event handler. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet21"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet21"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet21"::: + ]]> @@ -402,16 +402,16 @@ The following example demonstrates how to find the common if the current is a subset of the specified ; otherwise, . - @@ -443,16 +443,16 @@ The following example demonstrates how to find the common Gets the number of properties in the . The number of properties in the . - in a . This example assumes there is a called `packetOutput`. - + in a . This example assumes there is a called `packetOutput`. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet3"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.Windows.Input/StylusPointPropertyInfo.xml b/xml/System.Windows.Input/StylusPointPropertyInfo.xml index cb2bedbb7c7..9a834404d1d 100644 --- a/xml/System.Windows.Input/StylusPointPropertyInfo.xml +++ b/xml/System.Windows.Input/StylusPointPropertyInfo.xml @@ -24,21 +24,21 @@ Specifies the constraints of a property in a . - class inherits from the class and generates the , , , and values used to define the properties of a . The validity of each property value varies depending on the manufacture of the digitizer and stylus. - - - -## Examples - The following example creates an object from a and gets the information for each in the . - + class inherits from the class and generates the , , , and values used to define the properties of a . The validity of each property value varies depending on the manufacture of the digitizer and stylus. + + + +## Examples + The following example creates an object from a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -79,14 +79,14 @@ The to base the new on. Initializes a new instance of the class. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet16"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet16"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet16"::: + ]]> @@ -126,14 +126,14 @@ The scale that converts a property value into its units. Initializes a new instance of the class using the specified values. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet16"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet16"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet16"::: + ]]> @@ -171,16 +171,16 @@ Gets the maximum value accepted for the property. The maximum value accepted for the property. - object from a and gets the information for each in the . - + object from a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -218,16 +218,16 @@ Gets the minimum value accepted for the property. The minimum value accepted for the property. - object from a and gets the information for each in the . - + object from a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -265,21 +265,21 @@ Gets the scale that converts a property value into units. The scale that converts a property value into units. - property to get its unit-based value. For example, if a property's value is 100, the unit is inches, and the resolution is .01, then multiplying 100 by .01 reveals that the value of that property is 1 inch. - - - -## Examples - The following example creates a object from a and gets the information for each in the . - + property to get its unit-based value. For example, if a property's value is 100, the unit is inches, and the resolution is .01, then multiplying 100 by .01 reveals that the value of that property is 1 inch. + + + +## Examples + The following example creates a object from a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> @@ -317,16 +317,16 @@ Gets the type of measurement that is used by property. One of the values. - object from a and gets the information for each in the . - + object from a and gets the information for each in the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.cs" id="Snippet4"::: -:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: - +:::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDevice/GetStylusPoints/Window1.xaml.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.Windows.Input/StylusSystemGestureEventArgs.xml b/xml/System.Windows.Input/StylusSystemGestureEventArgs.xml index 467ddda888b..7b02915c52e 100644 --- a/xml/System.Windows.Input/StylusSystemGestureEventArgs.xml +++ b/xml/System.Windows.Input/StylusSystemGestureEventArgs.xml @@ -93,11 +93,11 @@ The target to call the handler on. Invokes a type-specific handler on the target whenever the event is raised. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/TabletDeviceCollection.xml b/xml/System.Windows.Input/TabletDeviceCollection.xml index 3ff7e75f737..33c217c87bf 100644 --- a/xml/System.Windows.Input/TabletDeviceCollection.xml +++ b/xml/System.Windows.Input/TabletDeviceCollection.xml @@ -102,7 +102,7 @@ method. + The following example demonstrates the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/StylusDeviceCollection/Overview/Window1.xaml.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/StylusDeviceCollection/Overview/Window1.xaml.vb" id="Snippet18"::: diff --git a/xml/System.Windows.Input/TextComposition.xml b/xml/System.Windows.Input/TextComposition.xml index e901a07ee4e..d3e22d6ec95 100644 --- a/xml/System.Windows.Input/TextComposition.xml +++ b/xml/System.Windows.Input/TextComposition.xml @@ -78,11 +78,11 @@ A string containing the initial text for the composition. This parameter will become the value of the property in the new class instance. Initializes a new instance of the class, taking a specified , source element, and composition text as initial values for the new instance. - , the new instance will have set to **On**. - + , the new instance will have set to **On**. + ]]> @@ -196,11 +196,11 @@ Completes this text composition. - method with this text composition as the input parameter. - + method with this text composition as the input parameter. + ]]> diff --git a/xml/System.Windows.Input/TextCompositionEventArgs.xml b/xml/System.Windows.Input/TextCompositionEventArgs.xml index fde68452219..cc3f3c1b43b 100644 --- a/xml/System.Windows.Input/TextCompositionEventArgs.xml +++ b/xml/System.Windows.Input/TextCompositionEventArgs.xml @@ -24,11 +24,11 @@ Contains arguments associated with changes to a . - class, and include (), (), and (). - + class, and include (), (), and (). + ]]> @@ -128,11 +128,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows.Input/TextCompositionManager.xml b/xml/System.Windows.Input/TextCompositionManager.xml index fdcaec03791..a044bc55fbe 100644 --- a/xml/System.Windows.Input/TextCompositionManager.xml +++ b/xml/System.Windows.Input/TextCompositionManager.xml @@ -64,11 +64,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -106,11 +106,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -148,11 +148,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -190,11 +190,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -232,11 +232,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -274,11 +274,11 @@ A delegate that designates the handler to add. Adds a handler for the attached event. - . - + . + ]]> @@ -354,13 +354,13 @@ Occurs when a is completed. - . - - This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. + ]]> @@ -417,13 +417,13 @@ Occurs when a new is started. - . - - This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. + ]]> @@ -480,13 +480,13 @@ Occurs when a is updated. - . - - This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event identified by the field. Use the and methods to manage this event on a specified dependency object. + ]]> @@ -553,11 +553,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -595,11 +595,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -637,11 +637,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -679,11 +679,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -721,11 +721,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -763,11 +763,11 @@ A delegate that designates the handler to remove. Removes a handler for the attached event. - . - + . + ]]> @@ -841,13 +841,13 @@ Occurs when a is completed. - . - - This is an attached event. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event. Use the and methods to manage this event on a specified dependency object. + ]]> @@ -904,13 +904,13 @@ Occurs when a new is started. - . - - This is an attached event. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event. Use the and methods to manage this event on a specified dependency object. + ]]> @@ -967,13 +967,13 @@ Occurs when a is updated. - . - - This is an attached event. Use the and methods to manage this event on a specified dependency object. - + . + + This is an attached event. Use the and methods to manage this event on a specified dependency object. + ]]> diff --git a/xml/System.Windows.Input/Touch.xml b/xml/System.Windows.Input/Touch.xml index 531563084d1..8541ee5858a 100644 --- a/xml/System.Windows.Input/Touch.xml +++ b/xml/System.Windows.Input/Touch.xml @@ -23,29 +23,29 @@ Provides an application-level service that processes multitouch input from the operating system and raises the event. - event is included in Windows Presentation Foundation (WPF) to support compatibility with Silverlight. If you do not have to ensure compatibility with Silverlight, use the touch events, such as and , on , , or . - - The event does not use the same event model as other WPF input events, such as and . Instead of being exposed as an element-specific event that potentially routes through the object tree of a UI, the event is a single event that is handled at the application level. Therefore, you cannot use the `sender` parameter of the event handler to determine what element is touched. - - Use the to get the values that are relevant to the touch event. From the , you can get the of the touch and determine whether the was a , , or action. You can also use the to get the . From the , you can determine the device and get information about the element that is touched. - - - -## Examples - The following example enables you to create simple patterns on a by dragging two fingers across a touchscreen. Each touch is represented by a . The pattern is created by drawing a line between the touch points provided by the touches. This example requires a Windows Touch-compatible screen. - - The following markup creates the user interface, which consists of a that is centered in a . - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml" id="Snippet000"::: - - The following code handles the event. When a touch presses on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - + event is included in Windows Presentation Foundation (WPF) to support compatibility with Silverlight. If you do not have to ensure compatibility with Silverlight, use the touch events, such as and , on , , or . + + The event does not use the same event model as other WPF input events, such as and . Instead of being exposed as an element-specific event that potentially routes through the object tree of a UI, the event is a single event that is handled at the application level. Therefore, you cannot use the `sender` parameter of the event handler to determine what element is touched. + + Use the to get the values that are relevant to the touch event. From the , you can get the of the touch and determine whether the was a , , or action. You can also use the to get the . From the , you can determine the device and get information about the element that is touched. + + + +## Examples + The following example enables you to create simple patterns on a by dragging two fingers across a touchscreen. Each touch is represented by a . The pattern is created by drawing a line between the touch points provided by the touches. This example requires a Windows Touch-compatible screen. + + The following markup creates the user interface, which consists of a that is centered in a . + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml" id="Snippet000"::: + + The following code handles the event. When a touch presses on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet100"::: + ]]> @@ -76,23 +76,23 @@ Occurs when a touch message is sent. - event and accessing the details of the from the event data. - - The event does not use the same event model as other WPF input events, such as and . Instead of being exposed as an element-specific event that potentially routes through the object tree of a UI, the event is a single event that is handled at the application level. Therefore, you cannot use the `sender` parameter of the event handler to determine what element is touched. - - - -## Examples - The following example handles the event. When a touch presses on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - This example is part of a larger example that is available in the class overview. - + event and accessing the details of the from the event data. + + The event does not use the same event model as other WPF input events, such as and . Instead of being exposed as an element-specific event that potentially routes through the object tree of a UI, the event is a single event that is handled at the application level. Therefore, you cannot use the `sender` parameter of the event handler to determine what element is touched. + + + +## Examples + The following example handles the event. When a touch presses on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + This example is part of a larger example that is available in the class overview. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml.cs" id="Snippet110"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet110"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet110"::: + ]]> diff --git a/xml/System.Windows.Input/TouchDevice.xml b/xml/System.Windows.Input/TouchDevice.xml index b72510f69e9..60e9bee60e5 100644 --- a/xml/System.Windows.Input/TouchDevice.xml +++ b/xml/System.Windows.Input/TouchDevice.xml @@ -44,7 +44,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Input/TouchDevice/Overview/mainwindow.xaml" id="Snippet000"::: - The following code handles the touch events. When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + The following code handles the touch events. When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/TouchDevice/Overview/mainwindow.xaml.cs" id="Snippet100"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/TouchDevice/Overview/mainwindow.xaml.vb" id="Snippet100"::: @@ -585,7 +585,7 @@ ## Examples - The following example handles the events that occur on a . When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + The following example handles the events that occur on a . When a touch moves on the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. This example is part of a larger example available in the class overview. @@ -665,7 +665,7 @@ method has no default implementation. It can be overridden in a derived class to perform any actions that are required when the touch input is captured. + The method has no default implementation. It can be overridden in a derived class to perform any actions that are required when the touch input is captured. ]]> @@ -739,7 +739,7 @@ method has no default implementation. It can be overridden in a derived class to perform any actions that are required when touch manipulation is started. + The method has no default implementation. It can be overridden in a derived class to perform any actions that are required when touch manipulation is started. ]]> diff --git a/xml/System.Windows.Input/TouchEventArgs.xml b/xml/System.Windows.Input/TouchEventArgs.xml index 679618e9654..f3bc7f0e411 100644 --- a/xml/System.Windows.Input/TouchEventArgs.xml +++ b/xml/System.Windows.Input/TouchEventArgs.xml @@ -206,7 +206,7 @@ of type and then invokes it. For more information about this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + This implementation casts the generic handler as an of type and then invokes it. For more information about this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). ]]> diff --git a/xml/System.Windows.Input/TouchFrameEventArgs.xml b/xml/System.Windows.Input/TouchFrameEventArgs.xml index d88671869fe..74a6f279c15 100644 --- a/xml/System.Windows.Input/TouchFrameEventArgs.xml +++ b/xml/System.Windows.Input/TouchFrameEventArgs.xml @@ -23,23 +23,23 @@ Provides data for the event. - event is included in Windows Presentation Foundation (WPF) to support compatibility with Silverlight. If you do not have to ensure compatibility with Silverlight, use the touch events, such as and , on , , or . - - Use the to get the values that are relevant to the touch event. From the , you can get the of the touch and determine whether the was a , , or action. You can also use the to get the . From the , you can determine the device and get information about the element that is touched. - - - -## Examples - The following example handles the event and accesses the touch data in the . When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - This example is part of a larger example that is available in the class overview. - + event is included in Windows Presentation Foundation (WPF) to support compatibility with Silverlight. If you do not have to ensure compatibility with Silverlight, use the touch events, such as and , on , , or . + + Use the to get the values that are relevant to the touch event. From the , you can get the of the touch and determine whether the was a , , or action. You can also use the to get the . From the , you can determine the device and get information about the element that is touched. + + + +## Examples + The following example handles the event and accesses the touch data in the . When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the move came from the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + This example is part of a larger example that is available in the class overview. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml.cs" id="Snippet110"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet110"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet110"::: + ]]> @@ -74,21 +74,21 @@ Returns the current touch point of the primary touch device relative to the specified element. The current position of the primary relative to the specified element; or if the primary is not active. - is the primary touch device. For example, if two fingers are touching the screen, the first finger that is down is represented by the primary touch device. If the first finger is lifted while the second finger is still down, the primary touch device becomes `null`. - - - -## Examples - The following code processes the touch points that are retrieved from the . When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the matches the of the primary touch point, which indicates the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - This example is part of a larger example that is available in the class overview. - + is the primary touch device. For example, if two fingers are touching the screen, the first finger that is down is represented by the primary touch device. If the first finger is lifted while the second finger is still down, the primary touch device becomes `null`. + + + +## Examples + The following code processes the touch points that are retrieved from the . When a touch is pressed on the , the is captured to the . When the touch is lifted, the is released. When a touch moves across the , the is checked. If the matches the of the primary touch point, which indicates the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + This example is part of a larger example that is available in the class overview. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml.cs" id="Snippet120"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet120"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet120"::: + ]]> @@ -123,16 +123,16 @@ Returns a collection that contains the current touch point for each active touch device relative to the specified element. A collection that contains the current for each active . - . When a touch is pressed on the canvas, the is captured to the canvas. When the touch is raised, the is released. When a touch moves across the canvas, the is checked. If the matches the of the primary touch point, which indicates the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. - - This example is part of a larger example that is available in the class overview. - + . When a touch is pressed on the canvas, the is captured to the canvas. When the touch is raised, the is released. When a touch moves across the canvas, the is checked. If the matches the of the primary touch point, which indicates the first touch, its location is recorded. If the move came from the second touch, a line is drawn from the position of the first touch to the position of the second touch. + + This example is part of a larger example that is available in the class overview. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/Touch/Overview/mainwindow.xaml.cs" id="Snippet120"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet120"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/Touch/Overview/mainwindow.xaml.vb" id="Snippet120"::: + ]]> @@ -163,11 +163,11 @@ This member is not implemented. - diff --git a/xml/System.Windows.Input/TraversalRequest.xml b/xml/System.Windows.Input/TraversalRequest.xml index 2a86cc0bc87..8e8e60ba50d 100644 --- a/xml/System.Windows.Input/TraversalRequest.xml +++ b/xml/System.Windows.Input/TraversalRequest.xml @@ -34,18 +34,18 @@ method. The method has a WPF framework-level override that provides a more practical implementation (), as well as a parallel implementation on and . You typically will set properties on in order to customize the focusing behavior when you request that the focus be moved to another element. + This class is used as an input parameter for the method. The method has a WPF framework-level override that provides a more practical implementation (), as well as a parallel implementation on and . You typically will set properties on in order to customize the focusing behavior when you request that the focus be moved to another element. This class is also used as input parameters for the following methods: -- , and implementations of that method that are used for interoperation (). +- , and implementations of that method that are used for interoperation (). -- . +- . ## Examples - The following example creates a instance as input for a call. + The following example creates a instance as input for a call. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/MoveFocus/Window1.xaml.cs" id="Snippetfocussamplemovefocus"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/MoveFocus/window1.xaml.vb" id="Snippetfocussamplemovefocus"::: @@ -85,7 +85,7 @@ instance as input for a call. + The following example creates a instance as input for a call. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/MoveFocus/Window1.xaml.cs" id="Snippetfocussamplemovefocus"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/MoveFocus/window1.xaml.vb" id="Snippetfocussamplemovefocus"::: @@ -181,7 +181,7 @@ ## Remarks Focusable elements are those elements where the property is `true`. - This parameter is primarily intended to communicate whether traversal using tab stops should wrap when calling the methods , ,or.. If you are passing focus to an object that implements , then specifying true for will result in that `true` value being passed to the implementation. + This parameter is primarily intended to communicate whether traversal using tab stops should wrap when calling the methods , ,or.. If you are passing focus to an object that implements , then specifying true for will result in that `true` value being passed to the implementation. ]]> diff --git a/xml/System.Windows.Interop/BrowserInteropHelper.xml b/xml/System.Windows.Interop/BrowserInteropHelper.xml index 2ca7627b3e6..680410cbd36 100644 --- a/xml/System.Windows.Interop/BrowserInteropHelper.xml +++ b/xml/System.Windows.Interop/BrowserInteropHelper.xml @@ -101,7 +101,7 @@ object, you can access the properties, methods, and events of the HTML window object, call a script function directly, or access a global variable. The syntax to access these items uses the familiar dot notation. + With the returned object, you can access the properties, methods, and events of the HTML window object, call a script function directly, or access a global variable. The syntax to access these items uses the familiar dot notation. For more information about the window object, see [Window](https://developer.mozilla.org/docs/Web/API/Window). @@ -110,7 +110,7 @@ This feature can be turned off for the browser by setting the **ScriptInteropDisallow** registry value. For more information, see [Security (WPF)](/dotnet/desktop/wpf/security-wpf?view=netframeworkdesktop-4.8). ## Examples - The following example demonstrates how to retrieve the object and close the browser window. + The following example demonstrates how to retrieve the object and close the browser window. :::code language="xaml" source="~/snippets/csharp/System.Windows.Interop/BrowserInteropHelper/HostScript/page1.xaml" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/BrowserInteropHelper/HostScript/page1.xaml.cs" id="Snippet10"::: @@ -156,7 +156,7 @@ ## Examples - The following example demonstrates how to use to determine if a is hosted in a browser. + The following example demonstrates how to use to determine if a is hosted in a browser. :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/BrowserInteropHelper/IsBrowserHosted/Page1.xaml.cs" id="Snippetisbrowserhostedcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Interop/BrowserInteropHelper/IsBrowserHosted/page1.xaml.vb" id="Snippetisbrowserhostedcode"::: @@ -195,7 +195,7 @@ property contains only a for XAML browser application (XBAP) applications. For an example of the property, see . + The property contains only a for XAML browser application (XBAP) applications. For an example of the property, see . ]]> diff --git a/xml/System.Windows.Interop/ComponentDispatcher.xml b/xml/System.Windows.Interop/ComponentDispatcher.xml index d2ddc67b8e7..ebabe2747a4 100644 --- a/xml/System.Windows.Interop/ComponentDispatcher.xml +++ b/xml/System.Windows.Interop/ComponentDispatcher.xml @@ -28,11 +28,11 @@ are specific to a particular thread. For example, if you examine the value of on two different threads, you might get different values. + Although the class itself is static, all members of are specific to a particular thread. For example, if you examine the value of on two different threads, you might get different values. The methods are static but they are backed by per-thread data structures. The static methods allow singleton access but the is sorting out the appropriate per-thread operations. - The owner of the message pump is defined by the code that calls the Win32 function [GetMessage](/windows/win32/api/winuser/nf-winuser-getmessage). The owner calls for every keyboard message. This method raises the event with the messages contained in the event data. If that event is not handled, the owner raises the event with the messages contained in the event argument. + The owner of the message pump is defined by the code that calls the Win32 function [GetMessage](/windows/win32/api/winuser/nf-winuser-getmessage). The owner calls for every keyboard message. This method raises the event with the messages contained in the event data. If that event is not handled, the owner raises the event with the messages contained in the event argument. > [!NOTE] > Only keyboard messages are supported. diff --git a/xml/System.Windows.Interop/D3DImage.xml b/xml/System.Windows.Interop/D3DImage.xml index 7f172ddc6ee..0a3d89e24d1 100644 --- a/xml/System.Windows.Interop/D3DImage.xml +++ b/xml/System.Windows.Interop/D3DImage.xml @@ -30,21 +30,21 @@ ## Remarks Use the class to host Direct3D content in a Windows Presentation Foundation (WPF) application. - Call the method to change the Direct3D content displayed by the . Call the method to assign a Direct3D surface to a . Call the method to track updates to the Direct3D surface. Call the method to display the changed areas. + Call the method to change the Direct3D content displayed by the . Call the method to assign a Direct3D surface to a . Call the method to track updates to the Direct3D surface. Call the method to display the changed areas. - The class manages two display buffers, which are called the *back buffer* and the *front buffer*. The back buffer is your Direct3D surface. Changes to the back buffer are copied forward to the front buffer when you call the method, where it is displayed on the hardware. Occasionally, the front buffer becomes unavailable. This lack of availability can be caused by screen locking, full-screen exclusive Direct3D applications, user-switching, or other system activities. When this occurs, your WPF application is notified by handling the event. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. + The class manages two display buffers, which are called the *back buffer* and the *front buffer*. The back buffer is your Direct3D surface. Changes to the back buffer are copied forward to the front buffer when you call the method, where it is displayed on the hardware. Occasionally, the front buffer becomes unavailable. This lack of availability can be caused by screen locking, full-screen exclusive Direct3D applications, user-switching, or other system activities. When this occurs, your WPF application is notified by handling the event. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. ## Responding to an Unavailable Front Buffer when WPF Does not Fall Back to Software Rendering - When you call the overload or call the overload with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when the front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . + When you call the overload or call the overload with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when the front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . ## Responding to an Unavailable Front Buffer when WPF Falls Back to Software Rendering - When you call the overload with the `enableSoftwareFallback` parameter set to `true`, the rendering system retains its reference to the back buffer when the front buffer becomes unavailable, so there is no need to call when the front buffer is available again. There may be situations where the user's device becomes unavailable. When that occurs, call to release WPF's reference to the back buffer. If you need to reset your device, call with the `backBuffer` parameter set to `null`, and then call again with `backBuffer` set to a valid Direct3D surface. + When you call the overload with the `enableSoftwareFallback` parameter set to `true`, the rendering system retains its reference to the back buffer when the front buffer becomes unavailable, so there is no need to call when the front buffer is available again. There may be situations where the user's device becomes unavailable. When that occurs, call to release WPF's reference to the back buffer. If you need to reset your device, call with the `backBuffer` parameter set to `null`, and then call again with `backBuffer` set to a valid Direct3D surface. > [!NOTE] > Performance depends greatly on the settings of the Direct3D surface. For more information, see [Performance Considerations for Direct3D9 and WPF Interoperability](/dotnet/framework/wpf/advanced/performance-considerations-for-direct3d9-and-wpf-interoperability). > [!NOTE] -> The class does not display Direct3D content when WPF renders in software, such as over a Remote Desktop connection, unless you call and specify `true` for the `enableSoftwareFallback` parameter. +> The class does not display Direct3D content when WPF renders in software, such as over a Remote Desktop connection, unless you call and specify `true` for the `enableSoftwareFallback` parameter. @@ -191,19 +191,19 @@ method to indicate changes your code has made to the back buffer. To be rendered, the changed area on the back buffer must have a corresponding changed area on the . + Call the method to indicate changes your code has made to the back buffer. To be rendered, the changed area on the back buffer must have a corresponding changed area on the . - Call the and methods before calling the method. + Call the and methods before calling the method. - Call the method to copy the changed areas to the front buffer. + Call the method to copy the changed areas to the front buffer. > [!NOTE] -> After a few calls to the method, the changed areas are merged into a single area. This means you must have valid data outside of the changed areas. +> After a few calls to the method, the changed areas are merged into a single area. This means you must have valid data outside of the changed areas. ## Examples - The following code example shows how to call the method to specify the changed region in the back buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). + The following code example shows how to call the method to specify the changed region in the back buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: @@ -258,7 +258,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -330,7 +330,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -410,9 +410,9 @@ method is called by clients such as the printing system and the class. + The method is called by clients such as the printing system and the class. - Optionally override the method to implement custom logic and return a different . For example, you can return a placeholder if the default implementation returns `null`. + Optionally override the method to implement custom logic and return a different . For example, you can return a placeholder if the default implementation returns `null`. ]]> @@ -450,7 +450,7 @@ class, you must override the method to enable correct cloning. The default implementation performs a `return new D3DImage()`, which will not be correct if the instance is a different class. + If you derive from the class, you must override the method to enable correct cloning. The default implementation performs a `return new D3DImage()`, which will not be correct if the instance is a different class. ]]> @@ -496,7 +496,7 @@ . Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. + This method overrides . Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. For more information, see [Finalize Methods and Destructors](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/0s71x931(v%3dvs.100)), [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged), and [Overriding the Finalize Method](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). @@ -642,7 +642,7 @@ can change when a new back buffer is assigned by a call to the method. + The value of can change when a new back buffer is assigned by a call to the method. ]]> @@ -681,7 +681,7 @@ event. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. For more information, see the remarks in the class. + Occasionally, the front buffer becomes unavailable. This lack of availability can be caused by screen locking, full-screen exclusive Direct3D applications, user-switching, or other system activities. When this occurs, your WPF application is notified by handling the event. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. For more information, see the remarks in the class. ## Dependency Property Information @@ -733,7 +733,7 @@ to be notified when the status of the front buffer changes. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. For more information, see the remarks in the class. + Handle the to be notified when the status of the front buffer changes. How your application responds to the front buffer becoming unavailable depends on whether WPF is enabled to fall back to software rendering. The method has an overload that takes a parameter that specifies whether WPF falls back to software rendering. For more information, see the remarks in the class. ]]> @@ -799,15 +799,15 @@ method to change the back buffer by calling the and methods. While the is locked, your application can also render to the Direct3D surface assigned to the back buffer. + Call the method to change the back buffer by calling the and methods. While the is locked, your application can also render to the Direct3D surface assigned to the back buffer. > [!NOTE] -> The method blocks when the rendering system is reading the back buffer to update the front buffer. Use the method to avoid blocking indefinitely. +> The method blocks when the rendering system is reading the back buffer to update the front buffer. Use the method to avoid blocking indefinitely. ## Examples - The following code example shows how to call the method to enable updates to the back buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). + The following code example shows how to call the method to enable updates to the back buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: @@ -878,7 +878,7 @@ can change when a new back buffer is assigned by a call to the method. + The value of can change when a new back buffer is assigned by a call to the method. @@ -923,7 +923,7 @@ can change when a new back buffer is assigned by a call to the method. + The value of can change when a new back buffer is assigned by a call to the method. @@ -988,12 +988,12 @@ method to assign a Direct3D surface to the back buffer. + Call the method to assign a Direct3D surface to the back buffer. > [!NOTE] > Performance depends greatly on the settings of the Direct3D surface. For more information, see [Performance Considerations for Direct3D9 and WPF Interoperability](/dotnet/framework/wpf/advanced/performance-considerations-for-direct3d9-and-wpf-interoperability). - Calling the overload is identical to calling the overload with the `enableSoftwareFallback` parameter set to `false`. When you call or call with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . + Calling the overload is identical to calling the overload with the `enableSoftwareFallback` parameter set to `false`. When you call or call with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . The following list shows the required back buffer settings for the `IDirect3DSurface9` type. @@ -1008,7 +1008,7 @@ ## Examples - The following code example shows how to call the method to assign a Direct3D surface. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). + The following code example shows how to call the method to assign a Direct3D surface. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: @@ -1065,9 +1065,9 @@ overload or call the overload with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when the front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . + When you call the overload or call the overload with the `enableSoftwareFallback` parameter set to `false`, the rendering system releases its reference to the back buffer when the front buffer becomes unavailable and nothing is displayed. When the front buffer is available again, the rendering system raises the event to notify your WPF application. You can create an event handler for the event to restart rendering again with a valid Direct3D surface. To restart rendering, you must call . - When you call with the `enableSoftwareFallback` parameter set to `true`, the rendering system retains its reference to the back buffer when the front buffer becomes unavailable, so there is no need to call when the front buffer is available again. There may be situations where the user's device becomes unavailable. When that occurs, call to release WPF's reference to the back buffer. If you need to reset your device, call with `backBuffer` set to `null`, and then call again with `backBuffer` set to a valid Direct3D surface. + When you call with the `enableSoftwareFallback` parameter set to `true`, the rendering system retains its reference to the back buffer when the front buffer becomes unavailable, so there is no need to call when the front buffer is available again. There may be situations where the user's device becomes unavailable. When that occurs, call to release WPF's reference to the back buffer. If you need to reset your device, call with `backBuffer` set to `null`, and then call again with `backBuffer` set to a valid Direct3D surface. The following list shows the required back buffer settings for the `IDirect3DSurface9` type. @@ -1152,9 +1152,9 @@ reaches zero, the is fully unlocked. The is marked for rendering if the image has changed areas that were specified by previous calls to the method. + When the lock count for the reaches zero, the is fully unlocked. The is marked for rendering if the image has changed areas that were specified by previous calls to the method. - When the changes are committed and rendering occurs, additional calls to the method block until the render thread has copied the contents of the back buffer to the front buffer. This synchronization avoids display artifacts, such as tearing. + When the changes are committed and rendering occurs, additional calls to the method block until the render thread has copied the contents of the back buffer to the front buffer. This synchronization avoids display artifacts, such as tearing. > [!NOTE] > Do not update the Direct3D surface while the is unlocked. @@ -1162,7 +1162,7 @@ ## Examples - The following code example shows how to call the method to copy the updated back buffer to the front buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). + The following code example shows how to call the method to copy the updated back buffer to the front buffer. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: @@ -1202,7 +1202,7 @@ can change when a new back buffer is assigned by a call to the method. + The value of can change when a new back buffer is assigned by a call to the method. ]]> diff --git a/xml/System.Windows.Interop/D3DResourceType.xml b/xml/System.Windows.Interop/D3DResourceType.xml index bea5645b788..773173c3fd4 100644 --- a/xml/System.Windows.Interop/D3DResourceType.xml +++ b/xml/System.Windows.Interop/D3DResourceType.xml @@ -23,18 +23,18 @@ Specifies the Direct3D surface types that are compatible with the class. - when you assign a Direct3D surface in the method. - - - -## Examples - The following code example shows how to specify the in a call to the method. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: - + when you assign a Direct3D surface in the method. + + + +## Examples + The following code example shows how to specify the in a call to the method. For more information, see [Walkthrough: Hosting Direct3D9 Content in WPF](/dotnet/framework/wpf/advanced/walkthrough-hosting-direct3d9-content-in-wpf). + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Interop/D3DImage/Overview/window1.xaml.cs" id="Snippet3"::: + ]]> diff --git a/xml/System.Windows.Interop/DynamicScriptObject.xml b/xml/System.Windows.Interop/DynamicScriptObject.xml index f67f54b5720..9d1600a0068 100644 --- a/xml/System.Windows.Interop/DynamicScriptObject.xml +++ b/xml/System.Windows.Interop/DynamicScriptObject.xml @@ -63,7 +63,7 @@ method returns a string representation of the default property or method. + If the script object cannot be converted to a string, the method returns a string representation of the default property or method. ]]> @@ -107,7 +107,7 @@ method throws an exception if an invalid access is attempted. + The method throws an exception if an invalid access is attempted. ]]> @@ -158,7 +158,7 @@ method throws an exception if an invalid access is attempted. + The method throws an exception if an invalid access is attempted. ]]> @@ -205,7 +205,7 @@ method throws an exception if the method does not exist. + The method throws an exception if the method does not exist. ]]> @@ -252,7 +252,7 @@ method throws an exception if an invalid access is attempted. + The method throws an exception if an invalid access is attempted. ]]> @@ -299,7 +299,7 @@ method throws an exception if an invalid access is attempted. + The method throws an exception if an invalid access is attempted. ]]> @@ -350,7 +350,7 @@ method throws an exception if an invalid access is attempted. + The method throws an exception if an invalid access is attempted. ]]> diff --git a/xml/System.Windows.Interop/HwndHost.xml b/xml/System.Windows.Interop/HwndHost.xml index 97aad59d5df..420b0574d90 100644 --- a/xml/System.Windows.Interop/HwndHost.xml +++ b/xml/System.Windows.Interop/HwndHost.xml @@ -39,7 +39,7 @@ . Override the method and create your Win32 window as a child of the parent window that is passed into the method. + To host a Win32 window, create a class that derives from . Override the method and create your Win32 window as a child of the parent window that is passed into the method. > [!IMPORTANT] > Although derives from , various properties of that come from and other intermediate classes such as are not generally mapped to possible Win32 equivalents. Also, not all / input events transfer across the interoperation boundary. derives from primarily so that an instance can be inserted into the widest variety of possible content models, and so that default layout characteristics can apply. For more details on , see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). @@ -122,7 +122,7 @@ . + This method's implementation is called from within the internal implementation of . The child window will be created only if the window is owned by the calling thread. @@ -196,7 +196,7 @@ > [!IMPORTANT] > This type or member is not available in the Internet security zone. - Derived classes can override this method (by the signature) if they need to do additional cleanup. + Derived classes can override this method (by the signature) if they need to do additional cleanup. ]]> @@ -239,7 +239,7 @@ > [!IMPORTANT] > This type or member is not available in the Internet security zone. > -> This method can be overridden, but not by this signature. See for the overridable signature. This parameterless signature is the one required by the interface contract, and it effectively calls the active implementation with `disposing` being `true`. +> This method can be overridden, but not by this signature. See for the overridable signature. This parameterless signature is the one required by the interface contract, and it effectively calls the active implementation with `disposing` being `true`. ]]> @@ -606,7 +606,7 @@ implementation, and return it as the return value. The implementation of does this, but the automation peer that it returns is an internal class. + The implementation of this method is typically to call the constructor of a specific implementation, and return it as the return value. The implementation of does this, but the automation peer that it returns is an internal class. ]]> @@ -700,7 +700,7 @@ > [!IMPORTANT] > This type or member is not available in the Internet security zone. > -> This is an override of the class handler and provides the behavior of translating the Win32 message into a Windows Presentation Foundation (WPF) event, marking the event as handled whenever appropriate. +> This is an override of the class handler and provides the behavior of translating the Win32 message into a Windows Presentation Foundation (WPF) event, marking the event as handled whenever appropriate. ]]> @@ -753,7 +753,7 @@ > [!IMPORTANT] > This type or member is not available in the Internet security zone. > -> This is an override of the class handler and provides the behavior of translating the Win32 message into a Windows Presentation Foundation (WPF) event, marking the event as handled whenever appropriate. +> This is an override of the class handler and provides the behavior of translating the Win32 message into a Windows Presentation Foundation (WPF) event, marking the event as handled whenever appropriate. ]]> diff --git a/xml/System.Windows.Interop/HwndSource.xml b/xml/System.Windows.Interop/HwndSource.xml index daf3618f891..e9a4b9a8052 100644 --- a/xml/System.Windows.Interop/HwndSource.xml +++ b/xml/System.Windows.Interop/HwndSource.xml @@ -67,25 +67,25 @@ - The parent window. -- The to include in the window procedure chain. If you specify a hook at construction time, it receives all messages for the window. You can use to add a hook after the window is created. +- The to include in the window procedure chain. If you specify a hook at construction time, it receives all messages for the window. You can use to add a hook after the window is created. -- The transparency settings. A top-level window can be configured to blend with the other windows on the desktop according to the per-pixel transparency of the WPF content. To enable this, set the property in the to `true`. This property can only be specified at construction time, and only through the constructor signature, and it imposes several limitations. +- The transparency settings. A top-level window can be configured to blend with the other windows on the desktop according to the per-pixel transparency of the WPF content. To enable this, set the property in the to `true`. This property can only be specified at construction time, and only through the constructor signature, and it imposes several limitations. - After you populate the structure, pass it to the constructor for the . + After you populate the structure, pass it to the constructor for the . **Object Lifetime** - An is a regular common language runtime (CLR) object, and its lifetime is managed by the garbage collector. Because the represents an unmanaged resource, implements . Synchronously calling immediately destroys the Win32 window if called from the owner thread. If called from another thread, the Win32 window is destroyed asynchronously. Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios. + An is a regular common language runtime (CLR) object, and its lifetime is managed by the garbage collector. Because the represents an unmanaged resource, implements . Synchronously calling immediately destroys the Win32 window if called from the owner thread. If called from another thread, the Win32 window is destroyed asynchronously. Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios. **Window Procedures** - The class implements its own window procedure. This window procedure is used to process important window messages, such as those related to layout, rendering, and input. However, you can also hook the window procedure for your own use. You can specify your own hook during construction by setting the property, or you can also use and to add and remove hooks after the window is created. The hooks are called by last-in first-out order, which enables your hooks to execute before the built-in processing. The actual hooks are held by a weak reference. Therefore, make sure that you manage the lifetime of your hook delegate. + The class implements its own window procedure. This window procedure is used to process important window messages, such as those related to layout, rendering, and input. However, you can also hook the window procedure for your own use. You can specify your own hook during construction by setting the property, or you can also use and to add and remove hooks after the window is created. The hooks are called by last-in first-out order, which enables your hooks to execute before the built-in processing. The actual hooks are held by a weak reference. Therefore, make sure that you manage the lifetime of your hook delegate. For more information about and other interoperation classes, see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). Notice how the constructors for take parameters that resemble the parameters for Win32 functions such as [CreateWindowEx](/windows/win32/api/winuser/nf-winuser-createwindowexa). - Scale transformations should not be applied to the of an . See Remarks for . + Scale transformations should not be applied to the of an . See Remarks for . ]]> @@ -375,7 +375,7 @@ by setting the parameter. + This value is set when you create the by setting the parameter. The default value is determined by the property. @@ -426,7 +426,7 @@ > [!IMPORTANT] > This method is not available in the Internet security zone. - Most Win32 messages that reach the have an approximate WPF equivalent. You use to handle the cases where the message has no WPF equivalent. + Most Win32 messages that reach the have an approximate WPF equivalent. You use to handle the cases where the message has no WPF equivalent. The delegate resembles the parameter profile of a Win32 main window procedure. All window messages that the main window procedure of the parent window receives are also forwarded to the delegates. @@ -468,7 +468,7 @@ is to automatically resize content and the window region based on changes reported through the WPF layout system. The window does not resize if it is currently minimized or if is set to . + The native behavior of is to automatically resize content and the window region based on changes reported through the WPF layout system. The window does not resize if it is currently minimized or if is set to . ]]> @@ -556,7 +556,7 @@ in order to override the value that returns. + Override in order to override the value that returns. ]]> @@ -593,9 +593,9 @@ to reference the from Win32 code. Use the handle for operations such as message handling and window behavior. + You can use the handle that is obtained from to reference the from Win32 code. Use the handle for operations such as message handling and window behavior. - To get just the handle, use . + To get just the handle, use . ]]> @@ -632,7 +632,7 @@ have set to this default value, unless a different value is passed as a parameter to the constructor for a specific instance, by using the property. + New instances of have set to this default value, unless a different value is passed as a parameter to the constructor for a specific instance, by using the property. ]]> @@ -676,9 +676,9 @@ > [!IMPORTANT] > This method is not available in the Internet security zone. - initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. + initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. - Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios, because an in some interoperation scenarios can generate several references to it across the interoperation boundaries that might prevent timely garbage collection. + Calling explicitly from the interoperating code might be necessary for certain interoperation scenarios, because an in some interoperation scenarios can generate several references to it across the interoperation boundaries that might prevent timely garbage collection. ]]> @@ -717,7 +717,7 @@ ## Remarks The event is raised before any resources are released by the . The event indicates that the object that raises the event is about to have all references to it removed. - Use and the property to avoid calling twice (which raises an exception). + Use and the property to avoid calling twice (which raises an exception). ]]> @@ -802,9 +802,9 @@ 2. Get the value of the property from that instance. -3. Pass that HWND value as a parameter to . +3. Pass that HWND value as a parameter to . - This technique can be useful if you then want to add general message processing to the window. However, whenever you create an , you are also responsible for destroying it. This is true even if the object for an application is disposed. For more information, see Remarks on . + This technique can be useful if you then want to add general message processing to the window. However, whenever you create an , you are also responsible for destroying it. This is true even if the object for an application is disposed. For more information, see Remarks on . ]]> @@ -852,7 +852,7 @@ . + The default implementation returns the same result as . ]]> @@ -978,7 +978,7 @@ initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. The event is raised and the value of becomes `false` as soon as is called. During this time, if you call again, raises an exception. + initiates related cleanup work for the HWND. If is called through a thread that is different from the main UI thread, the cleanup work may be deferred until it can be posted to the main UI thread. The event is raised and the value of becomes `false` as soon as is called. During this time, if you call again, raises an exception. ]]> @@ -1242,7 +1242,7 @@ constructor by using the property. + This property can be set only in the constructor by using the property. ]]> @@ -1290,7 +1290,7 @@ ## Remarks Use this property to connect a or another root visual to the . - Scale transformations should not be applied to the of an because this can disable behavior. The content will scale, but the enclosing window will not. Instead of applying the transformation to the object that is the , apply the transformation to an object that is a child element of the . You might need to add an extra enclosing element to the WPF content, such as a panel, in order to provide a scaleable object. + Scale transformations should not be applied to the of an because this can disable behavior. The content will scale, but the enclosing window will not. Instead of applying the transformation to the object that is the , apply the transformation to an object that is a child element of the . You might need to add an extra enclosing element to the WPF content, such as a panel, in order to provide a scaleable object. You can add a as the root visual, but only as a top-level window (with WS_OVERLAPPED), not as a child window. @@ -1331,7 +1331,7 @@ ## Remarks End users might indirectly set this property through application UI, if that functionality is exposed by the application. - Scale transformations should not be applied to the of an , because this can disable behavior. See Remarks for . + Scale transformations should not be applied to the of an , because this can disable behavior. See Remarks for . ]]> @@ -1368,7 +1368,7 @@ event is only raised when user interaction causes the change. If you set in code, the event is not raised. + The event is only raised when user interaction causes the change. If you set in code, the event is not raised. ]]> @@ -1915,7 +1915,7 @@ is to show non-rectangular top-level UI that works in interoperation scenarios. Therefore, showing the rectangular non-client area defeats that purpose. + When you enable per-pixel opacity, the system no longer draws the non-client area. This is because the intended purpose of is to show non-rectangular top-level UI that works in interoperation scenarios. Therefore, showing the rectangular non-client area defeats that purpose. ]]> diff --git a/xml/System.Windows.Interop/HwndSourceHook.xml b/xml/System.Windows.Interop/HwndSourceHook.xml index 60d745e00ee..eecde5f29ac 100644 --- a/xml/System.Windows.Interop/HwndSourceHook.xml +++ b/xml/System.Windows.Interop/HwndSourceHook.xml @@ -39,11 +39,11 @@ Represents the method that handles Win32 window messages. The appropriate return value depends on the particular message. See the message documentation details for the Win32 message being handled. - method to register this handler to receive messages. - + method to register this handler to receive messages. + ]]> diff --git a/xml/System.Windows.Interop/HwndSourceParameters.xml b/xml/System.Windows.Interop/HwndSourceParameters.xml index 999d5091415..9515a9ba984 100644 --- a/xml/System.Windows.Interop/HwndSourceParameters.xml +++ b/xml/System.Windows.Interop/HwndSourceParameters.xml @@ -32,7 +32,7 @@ The properties whose values are established by this structure are not directly exposed on instances when an is constructed. However, the values of the structure typically affect general UI properties such as "Height" and "Width" that might exist in specific hosted objects and their APIs. > [!IMPORTANT] -> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. +> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. ]]> @@ -52,7 +52,7 @@ ## Remarks > [!IMPORTANT] -> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. +> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. ]]> @@ -415,7 +415,7 @@ ## Remarks If a size was not assigned, the window has the default size. - Calls to or setting or all result in this property being `true`. + Calls to or setting or all result in this property being `true`. ]]> @@ -458,9 +458,9 @@ to `true`. + Unlike most methods that take rectangle screen-region measures in Windows Presentation Foundation (WPF), you specify this window size in device pixels, not the typical device-independent units. If you need to size your window to its content, set to `true`. - Do not set to 0 (zero). Doing so incurs a significant performance penalty in rendering. + Do not set to 0 (zero). Doing so incurs a significant performance penalty in rendering. ]]> @@ -552,7 +552,7 @@ method. + This implementation calls the method. ]]> @@ -595,7 +595,7 @@ method and inverts the result. + This implementation calls the method and inverts the result. ]]> @@ -750,7 +750,7 @@ is set to . + WPF automatically tries to restore focus to the window unless is set to . ]]> @@ -826,7 +826,7 @@ to `true`. + Unlike most methods that take rectangle screen-region measures in Windows Presentation Foundation (WPF), you specify this window size in device pixels, not in the typical device-independent units. If you need to size your window to its content, set to `true`. Do not pass 0 (zero) for either the `width` or `height` parameters. Although the method eventually succeeds even if you do pass 0, a substantial performance penalty occurs. @@ -938,9 +938,9 @@ ## Remarks By enabling per-pixel opacity, the system no longer draws the non-client area. - The opacity is used when the window is drawn on the desktop (it represents a final rendering step and does not appear as a contributor to property values such as ). + The opacity is used when the window is drawn on the desktop (it represents a final rendering step and does not appear as a contributor to property values such as ). - applies only to top-level windows. + applies only to top-level windows. ]]> @@ -1012,9 +1012,9 @@ to `true`. + Unlike most methods that take rectangle screen region measures in Windows Presentation Foundation (WPF), you specify this window's size in device pixels, not in the usual device-independent units. If you need to size your window to its content, set to `true`. - Do not set to 0 (zero). Doing so incurs a substantial performance penalty in rendering. + Do not set to 0 (zero). Doing so incurs a substantial performance penalty in rendering. ]]> @@ -1103,7 +1103,7 @@ ## Remarks > [!IMPORTANT] -> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. +> Do not construct instances of this structure using the default (parameterless) constructor. An instance that is created by the parameterless constructor results in that cannot be assigned a (even though the property appears to be settable). If such an instance is applied as the parameters for an constructor, the resulting cannot display a window. ]]> diff --git a/xml/System.Windows.Interop/IKeyboardInputSink.xml b/xml/System.Windows.Interop/IKeyboardInputSink.xml index 5d93f217ee3..69219fda3c7 100644 --- a/xml/System.Windows.Interop/IKeyboardInputSink.xml +++ b/xml/System.Windows.Interop/IKeyboardInputSink.xml @@ -22,17 +22,17 @@ Provides a keyboard sink for components that manages tabbing, accelerators, and mnemonics across interop boundaries and between HWNDs. This interface implements keyboard message management in WPF-Win32 interoperation scenarios. - and keep track of which component has focus. - - For a discussion of the input architecture specifically implemented for Windows Forms interop, see [Windows Forms and WPF Interoperability Input Architecture](/dotnet/framework/wpf/advanced/windows-forms-and-wpf-interoperability-input-architecture). - - and each implement the interface, through explicit interface definitions. The explicit definitions supply default behaviors, and can also be accessed if necessary through an interface cast of or . - + and keep track of which component has focus. + + For a discussion of the input architecture specifically implemented for Windows Forms interop, see [Windows Forms and WPF Interoperability Input Architecture](/dotnet/framework/wpf/advanced/windows-forms-and-wpf-interoperability-input-architecture). + + and each implement the interface, through explicit interface definitions. The explicit definitions supply default behaviors, and can also be accessed if necessary through an interface cast of or . + ]]> @@ -69,11 +69,11 @@ if the sink or one of its contained components has focus; otherwise, . - calls to child components with focus from within the implementation. Call recursively until you reach the level of specific focus and forward there. - + calls to child components with focus from within the implementation. Call recursively until you reach the level of specific focus and forward there. + ]]> @@ -113,11 +113,11 @@ Gets or sets a reference to the component's container's interface. A reference to the container's interface. - before any other methods are called, and it can be set multiple times after that. You should set the property to `null` again before disposal. - + before any other methods are called, and it can be set multiple times after that. You should set the property to `null` again before disposal. + ]]> @@ -164,15 +164,15 @@ if the message was handled; otherwise, . - method. - - An interface that returns `true` from will not call . Implementations can choose to perform all specific key combination handling in .and bypass . - + method. + + An interface that returns `true` from will not call . Implementations can choose to perform all specific key combination handling in .and bypass . + ]]> @@ -216,11 +216,11 @@ Registers the interface of a contained component. The site of the contained component. - @@ -257,11 +257,11 @@ if the focus has been set as requested; , if there are no tab stops. - and are the only relevant values that should be passed to this method in the . - + and are the only relevant values that should be passed to this method in the . + ]]> @@ -306,17 +306,17 @@ if the message was handled by the method implementation; otherwise, . - method on the child component that holds the current focus before returning a result. - - If the message cannot be handled immediately, you can re-dispatch it from within the implementation if necessary, and then return `false`. - - A primary scenario for translating accelerator keys is handling the VK_TAB keydown message and determining whether to set focus within the component, to call to a child component, or to call on the parent site because the tab sequence has reached the beginning or end bounds. Certain components may choose to not handle the tab key in this fashion. - + method on the child component that holds the current focus before returning a result. + + If the message cannot be handled immediately, you can re-dispatch it from within the implementation if necessary, and then return `false`. + + A primary scenario for translating accelerator keys is handling the VK_TAB keydown message and determining whether to set focus within the component, to call to a child component, or to call on the parent site because the tab sequence has reached the beginning or end bounds. Certain components may choose to not handle the tab key in this fashion. + ]]> @@ -362,11 +362,11 @@ if the message was processed and should not be called; otherwise, . - for that key message. - + for that key message. + ]]> diff --git a/xml/System.Windows.Interop/IKeyboardInputSite.xml b/xml/System.Windows.Interop/IKeyboardInputSite.xml index 041005f4b08..adec944f539 100644 --- a/xml/System.Windows.Interop/IKeyboardInputSite.xml +++ b/xml/System.Windows.Interop/IKeyboardInputSite.xml @@ -22,17 +22,17 @@ Manages keyboard focus within the container. This interface implements keyboard message management in WPF-Win32 interoperation scenarios. - interface and the are used together to provide support for keyboard actions across interoperation boundaries. A site ( implementation) represents a parent of a sink (). The sink () implements the majority of keyboard behavior. Each site must also provide a sink, because the site-specific sink is returned by a property of the interface. - - For a discussion of the input architecture specifically implemented for Windows Forms interoperation, see [Windows Forms and WPF Interoperability Input Architecture](/dotnet/framework/wpf/advanced/windows-forms-and-wpf-interoperability-input-architecture). - - For more information about WPF-Win32 interoperation scenarios, see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). - + interface and the are used together to provide support for keyboard actions across interoperation boundaries. A site ( implementation) represents a parent of a sink (). The sink () implements the majority of keyboard behavior. Each site must also provide a sink, because the site-specific sink is returned by a property of the interface. + + For a discussion of the input architecture specifically implemented for Windows Forms interoperation, see [Windows Forms and WPF Interoperability Input Architecture](/dotnet/framework/wpf/advanced/windows-forms-and-wpf-interoperability-input-architecture). + + For more information about WPF-Win32 interoperation scenarios, see [WPF and Win32 Interoperation](/dotnet/framework/wpf/advanced/wpf-and-win32-interoperation). + ]]> @@ -69,11 +69,11 @@ Called by a contained component when it has reached its last tab stop and has no further items to tab to. If this method returns , the site has shifted focus to another component. If this method returns , focus is still within the calling component. The component should "wrap around" and set focus to its first contained tab stop. - when the component attempts a requested focus move but there are no further tab stops in that direction within that own component. - + when the component attempts a requested focus move but there are no further tab stops in that direction within that own component. + ]]> @@ -107,11 +107,11 @@ Gets the keyboard sink associated with this site. The current site's interface. - interface. - + interface. + ]]> @@ -150,11 +150,11 @@ Unregisters a child keyboard input sink from this site. - diff --git a/xml/System.Windows.Interop/MSG.xml b/xml/System.Windows.Interop/MSG.xml index 9ddb1e2bc31..cffe3a04338 100644 --- a/xml/System.Windows.Interop/MSG.xml +++ b/xml/System.Windows.Interop/MSG.xml @@ -31,11 +31,11 @@ Contains message information from a thread's message queue. - @@ -81,11 +81,11 @@ Gets or sets the window handle (HWND) to the window whose window procedure receives the message. The window handle (HWND). - is `null` when the message is a thread message. - + is `null` when the message is a thread message. + ]]> @@ -174,11 +174,11 @@ Gets or sets the message identifier. The message identifier. - diff --git a/xml/System.Windows.Interop/RenderMode.xml b/xml/System.Windows.Interop/RenderMode.xml index 29453a8c76b..81d490f2e11 100644 --- a/xml/System.Windows.Interop/RenderMode.xml +++ b/xml/System.Windows.Interop/RenderMode.xml @@ -23,11 +23,11 @@ Specifies the rendering preference. - setting. - + setting. + ]]> diff --git a/xml/System.Windows.Interop/WindowInteropHelper.xml b/xml/System.Windows.Interop/WindowInteropHelper.xml index e3148d97c39..3a265e3210c 100644 --- a/xml/System.Windows.Interop/WindowInteropHelper.xml +++ b/xml/System.Windows.Interop/WindowInteropHelper.xml @@ -36,7 +36,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/ComponentResourceKey/.ctor/corepseudocode.cs" id="Snippetwindowinterophelper"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/ComponentResourceKey/.ctor/corepseudocode.vb" id="Snippetwindowinterophelper"::: - Another scenario supported by this class is to obtain a object from a WPF object. The enables direct processing of Win32 messages through the method. By using and in place of a you can still handle messages that have no equivalent or handling in WPF. Create a with the source, then call on the to get from HWND to . + Another scenario supported by this class is to obtain a object from a WPF object. The enables direct processing of Win32 messages through the method. By using and in place of a you can still handle messages that have no equivalent or handling in WPF. Create a with the source, then call on the to get from HWND to . ]]> @@ -117,17 +117,17 @@ method when you want to separate window handle (HWND) creation from the actual showing of the managed . This is useful when you have an automation client that can accomplish its tasks without the need for showing a window. + Use the method when you want to separate window handle (HWND) creation from the actual showing of the managed . This is useful when you have an automation client that can accomplish its tasks without the need for showing a window. If the native window has not yet been created, this method creates the native window, sets the property, and returns the HWND. If the native window has been created already, the handle of the existing native window is returned. If the native window is created as a result of calling this method, the event is raised. - Querying the property after the method is called returns the existing window handle. The visual tree is not attached to the window until after the method is called. + Querying the property after the method is called returns the existing window handle. The visual tree is not attached to the window until after the method is called. - Calling the method more than one time does not create new window handles. Calling the method when the handle has already been created by a call to the method does not create a new window handle. A native window is only created when no handle exists when the method is called. + Calling the method more than one time does not create new window handles. Calling the method when the handle has already been created by a call to the method does not create a new window handle. A native window is only created when no handle exists when the method is called. - Window properties that are set by using native window APIs via p/invoke may not appear in the managed window APIs. For example, if you set the window to be topmost by using the native MS_EX_TOPMOST flag after the method is called, the property is not guaranteed to reflect the native setting. + Window properties that are set by using native window APIs via p/invoke may not appear in the managed window APIs. For example, if you set the window to be topmost by using the native MS_EX_TOPMOST flag after the method is called, the property is not guaranteed to reflect the native setting. ]]> diff --git a/xml/System.Windows.Markup.Localizer/BamlLocalizabilityResolver.xml b/xml/System.Windows.Markup.Localizer/BamlLocalizabilityResolver.xml index 80ad892de17..bd63d1da2e4 100644 --- a/xml/System.Windows.Markup.Localizer/BamlLocalizabilityResolver.xml +++ b/xml/System.Windows.Markup.Localizer/BamlLocalizabilityResolver.xml @@ -29,13 +29,13 @@ ## Remarks is used by the in order to resolve localizability settings for classes and properties in BAML. The resolver is called both at the time of resource extraction as well as when localized BAML is updated. - At the time of resource extraction (), the resolver: + At the time of resource extraction (), the resolver: - Provides for classes and properties in BAML when the is constructing localizable resources. - Provides formatting preferences for elements in BAML so elements are formatted as inline tags. - At the time at which localized BAML is updated (), the resolver: + At the time at which localized BAML is updated (), the resolver: - Resolves formatting tags back into classes. diff --git a/xml/System.Windows.Markup.Localizer/BamlLocalizableResource.xml b/xml/System.Windows.Markup.Localizer/BamlLocalizableResource.xml index fe215fc28d1..8ba64e2bc88 100644 --- a/xml/System.Windows.Markup.Localizer/BamlLocalizableResource.xml +++ b/xml/System.Windows.Markup.Localizer/BamlLocalizableResource.xml @@ -199,7 +199,7 @@ attached property For more information on this attached property, see [Localization Attributes and Comments](/dotnet/framework/wpf/advanced/localization-attributes-and-comments). + Localization comments are authored by the developer to provide rules or hints for localizers. The comments are free-form strings that are extracted from BAML or from localization comments files. To attach comments to an element in Extensible Application Markup Language (XAML), use the attached property For more information on this attached property, see [Localization Attributes and Comments](/dotnet/framework/wpf/advanced/localization-attributes-and-comments). ]]> @@ -378,7 +378,7 @@ value serves as a recommendation to the localizer about whether the content of the localizable resource can be directly translated as plain strings. + The value serves as a recommendation to the localizer about whether the content of the localizable resource can be directly translated as plain strings. For example, when the string "Red" is used as a UI string, it can be directly translated to another language. In this case the property should be set to `true`. diff --git a/xml/System.Windows.Markup.Localizer/BamlLocalizableResourceKey.xml b/xml/System.Windows.Markup.Localizer/BamlLocalizableResourceKey.xml index e31c5b92887..af9c097a93b 100644 --- a/xml/System.Windows.Markup.Localizer/BamlLocalizableResourceKey.xml +++ b/xml/System.Windows.Markup.Localizer/BamlLocalizableResourceKey.xml @@ -24,21 +24,21 @@ Represents a key that is used to identify localizable resources in a . - , class name, and property name. - - The value must be added to the source Extensible Application Markup Language (XAML) file either by using the `updateuid` Microsoft build engine (MSBuild) target (for example, `msbuild /t:updateuid myproj.proj`), or manually in the markup. BAML without a cannot be localized. The class name is the type name of the element that contains the localizable property. The property name refers to the property that has the localizable value. A special property called "`$Content`" is used to represent values that are the initialization text or content property of an element. For example the `$Content` property name would apply to the initialization text `Click` in the following XAML: - - `Click ` - -## Examples - The following example demonstrates how to use a . - + , class name, and property name. + + The value must be added to the source Extensible Application Markup Language (XAML) file either by using the `updateuid` Microsoft build engine (MSBuild) target (for example, `msbuild /t:updateuid myproj.proj`), or manually in the markup. BAML without a cannot be localized. The class name is the type name of the element that contains the localizable property. The property name refers to the property that has the localizable value. A special property called "`$Content`" is used to represent values that are the initialization text or content property of an element. For example the `$Content` property name would apply to the initialization text `Click` in the following XAML: + + `Click ` + +## Examples + The following example demonstrates how to use a . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup.Localizer/BamlLocalizableResource/Overview/GrabBaml.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GrabBaml/visualbasic/grabbaml.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GrabBaml/visualbasic/grabbaml.vb" id="Snippet1"::: + ]]> @@ -118,11 +118,11 @@ Gets the name of the assembly that defines the type of the localizable resource as declared by its . The name of the assembly. - diff --git a/xml/System.Windows.Markup.Localizer/BamlLocalizer.xml b/xml/System.Windows.Markup.Localizer/BamlLocalizer.xml index d4b2d45034e..b06fb8a14a7 100644 --- a/xml/System.Windows.Markup.Localizer/BamlLocalizer.xml +++ b/xml/System.Windows.Markup.Localizer/BamlLocalizer.xml @@ -196,7 +196,7 @@ ## Remarks Under normal circumstances, ignores errors and continues localizing the source BAML input. As a result, the output BAML is partially localized. By listening for errors this event can be used to stop the and stop processing a source BAML file. - The most common user case where might be raised is as a result of an call where the update contained errors. For example, the event is raised if an attempted update set a duplicate key, or if the original and update did not have UID values that align. + The most common user case where might be raised is as a result of an call where the update contained errors. For example, the event is raised if an attempted update set a duplicate key, or if the original and update did not have UID values that align. ]]> @@ -233,7 +233,7 @@ method. + The following code example demonstrates how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup.Localizer/BamlLocalizableResource/Overview/GrabBaml.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GrabBaml/visualbasic/grabbaml.vb" id="Snippet1"::: diff --git a/xml/System.Windows.Markup.Localizer/ElementLocalizability.xml b/xml/System.Windows.Markup.Localizer/ElementLocalizability.xml index 908ceef2cf4..b0bafdf3944 100644 --- a/xml/System.Windows.Markup.Localizer/ElementLocalizability.xml +++ b/xml/System.Windows.Markup.Localizer/ElementLocalizability.xml @@ -143,11 +143,11 @@ Gets or sets the associated element's localizability attribute. The associated element's localizability attribute. - value will be ignored. - + value will be ignored. + ]]> @@ -191,11 +191,11 @@ Gets or sets the associated element's formatting tag. The formatting tag string. - diff --git a/xml/System.Windows.Markup.Primitives/MarkupObject.xml b/xml/System.Windows.Markup.Primitives/MarkupObject.xml index 94cabe0c321..b9a3896296c 100644 --- a/xml/System.Windows.Markup.Primitives/MarkupObject.xml +++ b/xml/System.Windows.Markup.Primitives/MarkupObject.xml @@ -24,11 +24,11 @@ Abstract class that represents an object that can be used to navigate a tree of objects. - , see method on the class. - + , see method on the class. + ]]> @@ -123,11 +123,11 @@ When overridden in a derived class, gets the instance of the object represented by this . The instance of the object. - if the instance represents a factory which creates instances of type . - + if the instance represents a factory which creates instances of type . + ]]> @@ -159,11 +159,11 @@ When overridden in a derived class, gets the type of the instance. The type of the object. - returns the type of the . For example, an item representing a would return the equivalent of **typeof(System.Windows.Button)**. - + returns the type of the . For example, an item representing a would return the equivalent of **typeof(System.Windows.Button)**. + ]]> diff --git a/xml/System.Windows.Markup.Primitives/MarkupProperty.xml b/xml/System.Windows.Markup.Primitives/MarkupProperty.xml index f3dabec0e30..d2caa742c96 100644 --- a/xml/System.Windows.Markup.Primitives/MarkupProperty.xml +++ b/xml/System.Windows.Markup.Primitives/MarkupProperty.xml @@ -24,15 +24,15 @@ Abstract class that provides a property description to be used while writing to markup which encapsulates access to properties and their values. - is `false`. - - If is `true`, the property is a list of items. - + is `false`. + + If is `true`, the property is a list of items. + ]]> @@ -93,11 +93,11 @@ When overridden in a derived class, gets the identifier for the markup property if the property is implemented as a dependency property. The dependency property identifier. - @@ -130,13 +130,13 @@ if the property is an attached ; otherwise, . - is `true`, is not `null` and can be `null`, but is not required to be. - + is `true`, is not `null` and can be `null`, but is not required to be. + ]]> @@ -169,15 +169,15 @@ is this property is a composite property; otherwise, . - is `false`, the property can be represented as a string and and are valid to use. - - If is `true`, the property is one or more items and is valid to use. - + is `false`, the property can be represented as a string and and are valid to use. + + If is `true`, the property is one or more items and is valid to use. + ]]> @@ -210,15 +210,15 @@ if this property represents a constructor argument; otherwise, . - is `true`, and are both `null`. - - XAML only uses for representing the constructor arguments of instances of . See [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). - + is `true`, and are both `null`. + + XAML only uses for representing the constructor arguments of instances of . See [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). + ]]> @@ -251,15 +251,15 @@ if the property represents direct content; otherwise, . - is `true`, and are both `null`. - - Dictionaries are included when determining whether this represents direct content. - + is `true`, and are both `null`. + + Dictionaries are included when determining whether this represents direct content. + ]]> @@ -292,15 +292,15 @@ if this property represents a key; otherwise, . - is `true`, and are `null`. - - XAML will use the identified property as an `x:Key` attribute. - + is `true`, and are `null`. + + XAML will use the identified property as an `x:Key` attribute. + ]]> @@ -333,15 +333,15 @@ , if this represents a string; otherwise, . - is `true`, and are both `null`. - - If the property is provided through and is `true`, it will be the only property the type will provide. - + is `true`, and are both `null`. + + If the property is provided through and is `true`, it will be the only property the type will provide. + ]]> @@ -373,15 +373,15 @@ When overridden in a derived class, gets the items that make up the value of this property. The items that make up the value of this property. - will not create a for properties with no items. - + will not create a for properties with no items. + ]]> @@ -413,11 +413,11 @@ When overridden in a derived class, gets a name that is used for diagnostics and error reporting. The identifier property name. - and/or instead. - + and/or instead. + ]]> @@ -449,11 +449,11 @@ When overridden in a derived class, gets the for the markup property. The property descriptor. - @@ -543,11 +543,11 @@ When overridden in a derived class, gets the set of types that this will reference when it serializes its value as a string. The set of types. - enables a serializer to ensure that the de-serializer has enough information to convert references to these type from the string representations. - + enables a serializer to ensure that the de-serializer has enough information to convert references to these type from the string representations. + ]]> diff --git a/xml/System.Windows.Markup.Primitives/MarkupWriter.xml b/xml/System.Windows.Markup.Primitives/MarkupWriter.xml index dd61ce96b61..10999871605 100644 --- a/xml/System.Windows.Markup.Primitives/MarkupWriter.xml +++ b/xml/System.Windows.Markup.Primitives/MarkupWriter.xml @@ -28,11 +28,11 @@ Provides methods to write an object to XAML format. - can be used to instantiate a . - + can be used to instantiate a . + ]]> diff --git a/xml/System.Windows.Markup/AmbientAttribute.xml b/xml/System.Windows.Markup/AmbientAttribute.xml index 91c2c06c623..64c5bb33412 100644 --- a/xml/System.Windows.Markup/AmbientAttribute.xml +++ b/xml/System.Windows.Markup/AmbientAttribute.xml @@ -76,7 +76,7 @@ ## WPF Scenarios for AmbientAttribute -- A property of a () can qualify the necessary property name lookups that are needed to find the backing references for property names in values. +- A property of a () can qualify the necessary property name lookups that are needed to find the backing references for property names in values. - All content within a `Resources` property (items of a ) as well as template content, should be able to access other peers as values. Declaring the entire `Resources` property as ambient invokes logic that enables this in the WPF XAML parser. diff --git a/xml/System.Windows.Markup/ArrayExtension.xml b/xml/System.Windows.Markup/ArrayExtension.xml index 992a81259b6..51a6c024ed1 100644 --- a/xml/System.Windows.Markup/ArrayExtension.xml +++ b/xml/System.Windows.Markup/ArrayExtension.xml @@ -74,7 +74,7 @@ is the class that implements the `x:Array` markup extension behavior, and the `x:ArrayExtension` information item from [MS-XAML]. `x:Array` supports a XAML language feature that allows adding arbitrary child elements within an array, through a particular markup extension enabled syntax. The markup extension syntax requires an explicit attribute on the markup extension usage, and a content syntax for specifying the . For more information and details on the syntax, see [x:Array Markup Extension](/dotnet/framework/xaml-services/x-array-markup-extension). + is the class that implements the `x:Array` markup extension behavior, and the `x:ArrayExtension` information item from [MS-XAML]. `x:Array` supports a XAML language feature that allows adding arbitrary child elements within an array, through a particular markup extension enabled syntax. The markup extension syntax requires an explicit attribute on the markup extension usage, and a content syntax for specifying the . For more information and details on the syntax, see [x:Array Markup Extension](/dotnet/framework/xaml-services/x-array-markup-extension). This class is a markup extension implementation. Markup extension classes exist mainly to provide infrastructure support for some aspect of a XAML processor implementation, and the members exposed by a markup extension class are not typically called from user code. This extension supports the [x:Array Markup Extension](/dotnet/framework/xaml-services/x-array-markup-extension) usage from XAML for .NET Framework XAML Services implementation of XAML and its XAML readers and XAML writers. @@ -261,7 +261,7 @@ to determine what method to call, or together with appropriate interface casting. + This method is not intended to be called directly, and does not participate in any existing .NET interpretation of the `x:Array` markup extension behavior. Any code access to the backing array instance should be done with array APIs or language features. Any alternative XAML reader or XAML writer implementations should instead use the .NET System.Xaml service extensions such as to determine what method to call, or together with appropriate interface casting. ]]> @@ -370,9 +370,9 @@ is the attributed XAML content property of . XAML content property designation supports the typical XAML usage of specifying the item elements of an array as child object elements in XAML. is the object model and markup extension implementation exposure for the intrinsic `ArrayExtension.Items` property, as defined for `x:ArrayExtension` in [MS-XAML]. + is the attributed XAML content property of . XAML content property designation supports the typical XAML usage of specifying the item elements of an array as child object elements in XAML. is the object model and markup extension implementation exposure for the intrinsic `ArrayExtension.Items` property, as defined for `x:ArrayExtension` in [MS-XAML]. - Type mismatches between and the items in , or any other validation issues, are not reported as exceptions until is invoked. This behavior is consistent with the general design principles of XAML markup extensions. + Type mismatches between and the items in , or any other validation issues, are not reported as exceptions until is invoked. This behavior is consistent with the general design principles of XAML markup extensions. For XAML usage information, see [x:Array Markup Extension](/dotnet/framework/xaml-services/x-array-markup-extension). diff --git a/xml/System.Windows.Markup/ComponentResourceKeyConverter.xml b/xml/System.Windows.Markup/ComponentResourceKeyConverter.xml index 02d042d30ad..b4d5e52b803 100644 --- a/xml/System.Windows.Markup/ComponentResourceKeyConverter.xml +++ b/xml/System.Windows.Markup/ComponentResourceKeyConverter.xml @@ -24,11 +24,11 @@ Implements a type converter for objects, which deliberately have no type conversion pathways. The type converter enforces and reports that behavior. - type should not use a type converter pathway to convert values. You should use markup extensions instead. For this reason, the and methods always return `false`. The and methods always throw an exception. The exceptions might possibly report invalid input, but even input that is considered valid will result in . - + type should not use a type converter pathway to convert values. You should use markup extensions instead. For this reason, the and methods always return `false`. The and methods always throw an exception. The exceptions might possibly report invalid input, but even input that is considered valid will result in . + ]]> @@ -100,11 +100,11 @@ in all cases. - type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. - + type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. + ]]> @@ -146,11 +146,11 @@ in all cases. - type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. - + type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. + ]]> @@ -193,11 +193,11 @@ Attempts to convert the specified object to a , using the specified context. Throws an exception in all cases. Throws an exception in all cases. - type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. - + type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. + ]]> Cannot perform the conversion. @@ -241,11 +241,11 @@ Attempts to convert a to the specified type, using the specified context. Throws an exception in all cases. Throws an exception in all cases. - type should not use a type converter pathway to convert values. You should use markup extensions instead. For this reason, the and methods always return `false`. The and methods always throw an exception. - + type should not use a type converter pathway to convert values. You should use markup extensions instead. For this reason, the and methods always return `false`. The and methods always throw an exception. + ]]> Cannot perform the conversion. diff --git a/xml/System.Windows.Markup/ConstructorArgumentAttribute.xml b/xml/System.Windows.Markup/ConstructorArgumentAttribute.xml index ef685f92c77..cc6e6cd90fb 100644 --- a/xml/System.Windows.Markup/ConstructorArgumentAttribute.xml +++ b/xml/System.Windows.Markup/ConstructorArgumentAttribute.xml @@ -47,22 +47,22 @@ Specifies that an object can be initialized by using a non-parameterless constructor syntax, and that a property of the specified name supplies construction information. This information is primarily for XAML serialization. - information is useful during serialization for producing an accurate representation of the typical markup extension usage. For more information about markup extensions, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). - - In order to be valid for a attribution, a type's public non-parameterless constructor must support exactly one parameter. The name of the parameter must correspond to a read/write property. The property must be otherwise serializable. You use this attribute to create the correspondence between the name of the parameter in the constructor, and the property. Specifically, you apply this attribute to the property-level definition of the connecting read/write property. - - Consumers of may throw in cases where does not resolve to type backing, or when applied to a type that does not have the appropriate construction arguments and arity. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - -## WPF Usage Notes - For more information about markup extensions and WPF, see [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). - + information is useful during serialization for producing an accurate representation of the typical markup extension usage. For more information about markup extensions, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). + + In order to be valid for a attribution, a type's public non-parameterless constructor must support exactly one parameter. The name of the parameter must correspond to a read/write property. The property must be otherwise serializable. You use this attribute to create the correspondence between the name of the parameter in the constructor, and the property. Specifically, you apply this attribute to the property-level definition of the connecting read/write property. + + Consumers of may throw in cases where does not resolve to type backing, or when applied to a type that does not have the appropriate construction arguments and arity. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + +## WPF Usage Notes + For more information about markup extensions and WPF, see [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). + ]]> diff --git a/xml/System.Windows.Markup/ContentPropertyAttribute.xml b/xml/System.Windows.Markup/ContentPropertyAttribute.xml index b3663d4c7a2..ff47edf62d1 100644 --- a/xml/System.Windows.Markup/ContentPropertyAttribute.xml +++ b/xml/System.Windows.Markup/ContentPropertyAttribute.xml @@ -59,7 +59,7 @@ In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase, and also had a parallel implementation in Windows Communication Foundation (WCF). Starting with the .NET Framework 4.0, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). ## WPF Usage Notes - An example of a class in Windows Presentation Foundation (WPF) that uses the is , which the class inherits from. The property is the content property set by the . If a is instantiated in XAML, the of the will be set to the element that is between the start and end button tags. + An example of a class in Windows Presentation Foundation (WPF) that uses the is , which the class inherits from. The property is the content property set by the . If a is instantiated in XAML, the of the will be set to the element that is between the start and end button tags. ## Examples The following example creates a class named `Film` that has a applied. The property named `Title` is indicated as the content property. @@ -163,7 +163,7 @@ of the relevant property in the CLR type system. + Assuming CLR backing, the provided `name` should match the of the relevant property in the CLR type system. ]]> diff --git a/xml/System.Windows.Markup/ContentWrapperAttribute.xml b/xml/System.Windows.Markup/ContentWrapperAttribute.xml index 24a587a7228..b43ac2193d0 100644 --- a/xml/System.Windows.Markup/ContentWrapperAttribute.xml +++ b/xml/System.Windows.Markup/ContentWrapperAttribute.xml @@ -51,15 +51,15 @@ Specifies one or more types on the associated collection type that will be used to wrap foreign content. - . - - is an example of a WPF class that has the attribute applied. In this case there are two separate attributed wrapper classes. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - + . + + is an example of a WPF class that has the attribute applied. In this case there are two separate attributed wrapper classes. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + ]]> diff --git a/xml/System.Windows.Markup/DateTimeValueSerializer.xml b/xml/System.Windows.Markup/DateTimeValueSerializer.xml index e11b0c5dac1..6a1679a6a26 100644 --- a/xml/System.Windows.Markup/DateTimeValueSerializer.xml +++ b/xml/System.Windows.Markup/DateTimeValueSerializer.xml @@ -43,13 +43,13 @@ Converts instances of to and from instances of . - is used rather than for cases where type conversion requires additional state. is not attributed to a type with . This is because is in mscorlib, and mscorlib cannot take dependencies on attribute classes that it does not define itself. Instead, usage of is special-cased into XAML processor behavior in .NET Framework XAML Services behavior. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. See [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - + is used rather than for cases where type conversion requires additional state. is not attributed to a type with . This is because is in mscorlib, and mscorlib cannot take dependencies on attribute classes that it does not define itself. Instead, usage of is special-cased into XAML processor behavior in .NET Framework XAML Services behavior. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. See [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + ]]> @@ -127,11 +127,11 @@ if the value can be converted; otherwise, . - @@ -173,11 +173,11 @@ if can be converted into a ; otherwise, . - . - + . + ]]> @@ -218,13 +218,13 @@ Converts a into a . A new instance of based on the supplied . - . - - The current implementation uses internally, and also uses the following : `DateTimeStyles.RoundtripKind | DateTimeStyles.NoCurrentDateDefault | DateTimeStyles.AllowLeadingWhite | DateTimeStyles.AllowTrailingWhite`. - + . + + The current implementation uses internally, and also uses the following : `DateTimeStyles.RoundtripKind | DateTimeStyles.NoCurrentDateDefault | DateTimeStyles.AllowLeadingWhite | DateTimeStyles.AllowTrailingWhite`. + ]]> @@ -267,15 +267,15 @@ Converts an instance of to a . A string representation of the specified . - have values. For example, if there is no value in , the format string is in the form `yyyy-MM-dd` rather than writing out full-verbosity zero values for the time component. - + have values. For example, if there is no value in , the format string is in the form `yyyy-MM-dd` rather than writing out full-verbosity zero values for the time component. + ]]> diff --git a/xml/System.Windows.Markup/DependencyPropertyConverter.xml b/xml/System.Windows.Markup/DependencyPropertyConverter.xml index a7f07ad1379..900699c0d8b 100644 --- a/xml/System.Windows.Markup/DependencyPropertyConverter.xml +++ b/xml/System.Windows.Markup/DependencyPropertyConverter.xml @@ -33,7 +33,7 @@ For legacy reasons, this class also supports conversion from BAML records, but this is an implementation detail and should not be relied upon. - The behavior of this converter is specifically oriented around a single WPF scenario for XAML processing: reading the attribute value of and generating a value. + The behavior of this converter is specifically oriented around a single WPF scenario for XAML processing: reading the attribute value of and generating a value. ]]> diff --git a/xml/System.Windows.Markup/DependsOnAttribute.xml b/xml/System.Windows.Markup/DependsOnAttribute.xml index 7f075224d5a..910f1a4c114 100644 --- a/xml/System.Windows.Markup/DependsOnAttribute.xml +++ b/xml/System.Windows.Markup/DependsOnAttribute.xml @@ -50,7 +50,7 @@ method on will process the specified property before processing the property that this attribute is set on. + The method on will process the specified property before processing the property that this attribute is set on. The `name` value applied to this attribute must be the simple unqualified name of a property that exists in the same type. You cannot specify attached properties as being dependent. @@ -61,7 +61,7 @@ In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). ## WPF Usage Notes - The property on the class is an example of a property in WPF where the attribute is applied. depends on and being processed first, otherwise there is no way to know what type is supposed to be created for value converter cases. + The property on the class is an example of a property in WPF where the attribute is applied. depends on and being processed first, otherwise there is no way to know what type is supposed to be created for value converter cases. ]]> @@ -177,7 +177,7 @@ to be applied. So long as dependencies are not circular or otherwise ambiguous, multiple references to the same property name are supported. + This is a generated value that uses an override behavior in order to permit multiple attributes with the same to be applied. So long as dependencies are not circular or otherwise ambiguous, multiple references to the same property name are supported. ]]> diff --git a/xml/System.Windows.Markup/DesignerSerializationOptionsAttribute.xml b/xml/System.Windows.Markup/DesignerSerializationOptionsAttribute.xml index 12a36ef6f44..127e949adb3 100644 --- a/xml/System.Windows.Markup/DesignerSerializationOptionsAttribute.xml +++ b/xml/System.Windows.Markup/DesignerSerializationOptionsAttribute.xml @@ -30,15 +30,15 @@ Specifies the serialization flags for a property. - provides a constraint hint for the form that designers and design surfaces should use when interacting with the attributed property. Generally the reason for doing so is to hint . You might do this in cases where interacting with that property as a content-serialized form of the string has risk of introducing spurious white space. An example case where is applied for this reason is . - - Attribute usage for supports assigning to a method. This enables you to declare serialization options for a XAML attached property, by assigning on the `Get` accessor method that supports the attached property usage pattern. An example of this in the WPF types is and its `Get` accessor . - - Note that hints the desired serialization form, not whether the property is or is not serialized. If you want to influence other aspects of property serialization, you can use , or can implement `ShouldSerialize` pattern methods on the owner class. For more information on the general .NET serialization patterns for design time, see [Designer Serialization Overview](https://msdn.microsoft.com/library/c342635a-aa5f-4281-915b-b013738af15a). - + provides a constraint hint for the form that designers and design surfaces should use when interacting with the attributed property. Generally the reason for doing so is to hint . You might do this in cases where interacting with that property as a content-serialized form of the string has risk of introducing spurious white space. An example case where is applied for this reason is . + + Attribute usage for supports assigning to a method. This enables you to declare serialization options for a XAML attached property, by assigning on the `Get` accessor method that supports the attached property usage pattern. An example of this in the WPF types is and its `Get` accessor . + + Note that hints the desired serialization form, not whether the property is or is not serialized. If you want to influence other aspects of property serialization, you can use , or can implement `ShouldSerialize` pattern methods on the owner class. For more information on the general .NET serialization patterns for design time, see [Designer Serialization Overview](https://msdn.microsoft.com/library/c342635a-aa5f-4281-915b-b013738af15a). + ]]> @@ -107,11 +107,11 @@ Gets the set on the attribute. The serialization option, as a value of the enumeration. - . - + . + ]]> diff --git a/xml/System.Windows.Markup/DictionaryKeyPropertyAttribute.xml b/xml/System.Windows.Markup/DictionaryKeyPropertyAttribute.xml index 8f47ffdf2ba..f19092e0e58 100644 --- a/xml/System.Windows.Markup/DictionaryKeyPropertyAttribute.xml +++ b/xml/System.Windows.Markup/DictionaryKeyPropertyAttribute.xml @@ -47,24 +47,24 @@ Specifies a property of the associated class that provides the implicit key value. Implicit keys are used for keys rather than explicit attributes defined in XAML for an item in collections. - dictionary (such as the WPF ) require a key. In XAML, the key is typically specified by `x:Key` attribute in the XAML markup for each item in the . The is applied to classes that work with an implicit key, where the key to use for inclusion comes from a different property value in the class. Instances of the class applying the can be included in an without an explicit key so long as the property referenced by has a value that is valid as a key in that dictionary implementation. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - -## WPF Usage Notes - The following list references examples of WPF APIs where this attribute is applied: - -- - -- - -- - - For more information about the WPF resource dictionary implications of , see [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). - + dictionary (such as the WPF ) require a key. In XAML, the key is typically specified by `x:Key` attribute in the XAML markup for each item in the . The is applied to classes that work with an implicit key, where the key to use for inclusion comes from a different property value in the class. Instances of the class applying the can be included in an without an explicit key so long as the property referenced by has a value that is valid as a key in that dictionary implementation. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + +## WPF Usage Notes + The following list references examples of WPF APIs where this attribute is applied: + +- + +- + +- + + For more information about the WPF resource dictionary implications of , see [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). + ]]> diff --git a/xml/System.Windows.Markup/IComponentConnector.xml b/xml/System.Windows.Markup/IComponentConnector.xml index 040918c5c34..ecd2c6bddbd 100644 --- a/xml/System.Windows.Markup/IComponentConnector.xml +++ b/xml/System.Windows.Markup/IComponentConnector.xml @@ -46,7 +46,7 @@ ## Remarks This interface is used internally by . - Implementations of are widely observable as part of the infrastructure provided by frameworks or technologies that use XAML combined with application and programming models. For example, whenever you look at the generated classes for XAML root elements in WPF pages and applications, you will see defined in the output. That method also exists in the compiled assembly and plays a role in the WPF application model of loading the XAML UI content at XAML parse time. For more information on the WPF integration of the `InitializeComponent` concept, see [Application Management Overview](/dotnet/framework/wpf/app-development/application-management-overview) or [Code-Behind and XAML in WPF](/dotnet/framework/wpf/advanced/code-behind-and-xaml-in-wpf). + Implementations of are widely observable as part of the infrastructure provided by frameworks or technologies that use XAML combined with application and programming models. For example, whenever you look at the generated classes for XAML root elements in WPF pages and applications, you will see defined in the output. That method also exists in the compiled assembly and plays a role in the WPF application model of loading the XAML UI content at XAML parse time. For more information on the WPF integration of the `InitializeComponent` concept, see [Application Management Overview](/dotnet/framework/wpf/app-development/application-management-overview) or [Code-Behind and XAML in WPF](/dotnet/framework/wpf/advanced/code-behind-and-xaml-in-wpf). In previous versions of the .NET Framework, this interface existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. . For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). @@ -136,7 +136,7 @@ ## Remarks is used internally by . - Implementations of are widely observable as part of the infrastructure provided by frameworks or technologies that use XAML combined with application and programming models. For example, whenever you look at the generated classes for XAML root elements in WPF pages and applications, you will see defined in the output. That method also exists in the compiled assembly and plays a role in the WPF application model of loading the XAML UI content at XAML parse time. For more information on the WPF integration of the `InitializeComponent` concept, see [Application Management Overview](/dotnet/framework/wpf/app-development/application-management-overview) or [Code-Behind and XAML in WPF](/dotnet/framework/wpf/advanced/code-behind-and-xaml-in-wpf). + Implementations of are widely observable as part of the infrastructure provided by frameworks or technologies that use XAML combined with application and programming models. For example, whenever you look at the generated classes for XAML root elements in WPF pages and applications, you will see defined in the output. That method also exists in the compiled assembly and plays a role in the WPF application model of loading the XAML UI content at XAML parse time. For more information on the WPF integration of the `InitializeComponent` concept, see [Application Management Overview](/dotnet/framework/wpf/app-development/application-management-overview) or [Code-Behind and XAML in WPF](/dotnet/framework/wpf/advanced/code-behind-and-xaml-in-wpf). ]]> diff --git a/xml/System.Windows.Markup/INameScopeDictionary.xml b/xml/System.Windows.Markup/INameScopeDictionary.xml index 4257bf1c06b..d4d9eeb9b4e 100644 --- a/xml/System.Windows.Markup/INameScopeDictionary.xml +++ b/xml/System.Windows.Markup/INameScopeDictionary.xml @@ -47,13 +47,13 @@ Unifies enumerable, collection, and dictionary support that are useful for exposing a dictionary of names in a XAML namescope. - defines no members of its own. Instead, the interface inherits , and generic interfaces, with and (or a thereof) as constraints. also inherits . - - The interface is used internally as a type for information passing, as part of object writer context for the WPF XAML implementation. - + defines no members of its own. Instead, the interface inherits , and generic interfaces, with and (or a thereof) as constraints. also inherits . + + The interface is used internally as a type for information passing, as part of object writer context for the WPF XAML implementation. + ]]> diff --git a/xml/System.Windows.Markup/IProvideValueTarget.xml b/xml/System.Windows.Markup/IProvideValueTarget.xml index 032b2c93373..4a96a8f3352 100644 --- a/xml/System.Windows.Markup/IProvideValueTarget.xml +++ b/xml/System.Windows.Markup/IProvideValueTarget.xml @@ -59,15 +59,15 @@ Type converters and markup extensions can query for as a service on the service context that is provided by a XAML object writer, when the XAML object writer invokes value conversion behavior. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). - For markup extensions specifically, a scenario where is useful is to determine the validity of your markup extension's situational usage. For example, your markup extension might implement a value deferral mechanism, but using that mechanism might only be appropriate if the target object is capable of using other components of your deferral mechanism at run time. You could check the type system characteristics of the object returned as and make sure that object supports your deferral technique. If so, your markup extension returns a value, and if not, your markup extension throws an exception that will be picked up as an inner exception by a XAML object writer. A similar scenario is assuring that a particular property supports a capability, by checking type system characteristics of the . + For markup extensions specifically, a scenario where is useful is to determine the validity of your markup extension's situational usage. For example, your markup extension might implement a value deferral mechanism, but using that mechanism might only be appropriate if the target object is capable of using other components of your deferral mechanism at run time. You could check the type system characteristics of the object returned as and make sure that object supports your deferral technique. If so, your markup extension returns a value, and if not, your markup extension throws an exception that will be picked up as an inner exception by a XAML object writer. A similar scenario is assuring that a particular property supports a capability, by checking type system characteristics of the . - Although the API name might imply an association with , the information reported by can also be useful to a or . A or typically have more context than a markup extension because they are dedicated to a particular target type or target property, and thus the situational validity is usually predictable in the type system. However, other scenarios exist. The following is a list of some scenarios that might be implemented by either a type converter or a markup extension: + Although the API name might imply an association with , the information reported by can also be useful to a or . A or typically have more context than a markup extension because they are dedicated to a particular target type or target property, and thus the situational validity is usually predictable in the type system. However, other scenarios exist. The following is a list of some scenarios that might be implemented by either a type converter or a markup extension: -- Get to read instance values of other properties on that object. Note that your handling here might need to be robust for unset values, because the processing order of XAML members on the target object can be nondeterministic. +- Get to read instance values of other properties on that object. Note that your handling here might need to be robust for unset values, because the processing order of XAML members on the target object can be nondeterministic. -- Get to read type-level metadata, or to verify that required interfaces are implemented by the type. +- Get to read type-level metadata, or to verify that required interfaces are implemented by the type. -- Get to read property metadata. +- Get to read property metadata. One scenario is to use information to limit which objects or properties are permitted to be set by your markup extension. @@ -77,7 +77,7 @@ > When using the service, it is particularly important not to modify the object referenced by the property, or other objects referenced by that object. For WPF specifically, these changes could cause unexpected changes that would invalidate the WPF property system. > [!NOTE] -> Do not use the type of to determine which precise type a markup extension or type converter should return. That is not a best practice. Your return type should be consistent with attributing ( for markup extensions) or patterns (class name of the type converter). +> Do not use the type of to determine which precise type a markup extension or type converter should return. That is not a best practice. Your return type should be consistent with attributing ( for markup extensions) or patterns (class name of the type converter). In previous versions of the .NET Framework, this interface existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). @@ -90,7 +90,7 @@ A default internal service provider for WPF implements for usage by a custom markup extension or type converter. The object and property reported by can only be set by the internal WPF service. Going beyond this definition of how operates would require defining your own service provider for markup extension and type converter usages that implements at the very least the and services, and that is an advanced scenario that is not described here. - A null value for or does not necessarily mean that a markup extension or type converter cannot act, although that depends on your implementation. An example case where the values from are null even if the service is available is if your markup extension is nested within another markup extension, such as a . An implementation that relies on should always check for null values if only for the purpose of throwing a specific exception, if that is your intended design. + A null value for or does not necessarily mean that a markup extension or type converter cannot act, although that depends on your implementation. An example case where the values from are null even if the service is available is if your markup extension is nested within another markup extension, such as a . An implementation that relies on should always check for null values if only for the purpose of throwing a specific exception, if that is your intended design. ]]> @@ -135,7 +135,7 @@ is the actual reference, not a type system identifier or other identifier. The value can also be `null`; see . + The value returned by is the actual reference, not a type system identifier or other identifier. The value can also be `null`; see . > [!IMPORTANT] > When using the service, it is particularly important not to modify the object referenced by the property, or other objects referenced by that object as properties that are not specifically the value-conversion case you are handling. For WPF specifically, changing the target object could cause unexpected changes that would invalidate the WPF property system. diff --git a/xml/System.Windows.Markup/IQueryAmbient.xml b/xml/System.Windows.Markup/IQueryAmbient.xml index 3623a0eca8a..c65bfa5676c 100644 --- a/xml/System.Windows.Markup/IQueryAmbient.xml +++ b/xml/System.Windows.Markup/IQueryAmbient.xml @@ -26,24 +26,24 @@ ## Remarks The purpose of an ambient property mechanism is to improve parsing time by informing a XAML object writer to avoid instantiating certain objects, in cases where it is known that the objects are for values that are temporary and not useful for a typical run time application. Normally, XAML lookups or XAML processing of a property get accessor would need to instantiate such objects to fill the object graph representation with ready-to-use values. - has one member: . + has one member: . - is a parallel mechanism to . is the specialized mechanism that avoids using reflection to determine information, and can also act situationally (a given object could choose to report `true` or `false` for ), whereas the attribute is essentially static analysis). is the general mechanism that can be used by XAML object writers and that typically correlates to the dedicated XAML type system properties and . + is a parallel mechanism to . is the specialized mechanism that avoids using reflection to determine information, and can also act situationally (a given object could choose to report `true` or `false` for ), whereas the attribute is essentially static analysis). is the general mechanism that can be used by XAML object writers and that typically correlates to the dedicated XAML type system properties and . ## WPF Implementations of IQueryAmbient In WPF, is used for the resource dictionary lookup process. The lookup process gets successive `Resources` values throughout the WPF logical tree, working towards the root of the resource scope until either a key is found or the key is determined to not exist in scope. Normally, doing so would require instantiating a each time to receive the results. Declaring the contents of `Resources` as ambient so long as `Resources` exists optimizes this lookup process. In WPF, this interface is implemented in the following cases: -- implements to return `true` for all property names if it contains an existing for , and so long as the query is not for the property itself. +- implements to return `true` for all property names if it contains an existing for , and so long as the query is not for the property itself. -- implements the same pattern for its . +- implements the same pattern for its . -- implements the same pattern for its . +- implements the same pattern for its . -- implements the same pattern for its . +- implements the same pattern for its . -- implements the same pattern for its . It also reports content as ambient but returns `false` if querying for itself. +- implements the same pattern for its . It also reports content as ambient but returns `false` if querying for itself. -- In each of these cases, the relevant `Resources` property (and ) are attributed as . The typical usage is to query for the properties that are NOT the attributed properties of the object that defines the interface. In other words, so long as a resource dictionary exists in order to provide the potential run time value when the object graph is created, any other property besides the resource dictionary's property container can be treated as ambient. +- In each of these cases, the relevant `Resources` property (and ) are attributed as . The typical usage is to query for the properties that are NOT the attributed properties of the object that defines the interface. In other words, so long as a resource dictionary exists in order to provide the potential run time value when the object graph is created, any other property besides the resource dictionary's property container can be treated as ambient. ]]> diff --git a/xml/System.Windows.Markup/IUriContext.xml b/xml/System.Windows.Markup/IUriContext.xml index 217a19f6e4f..9d43ac35955 100644 --- a/xml/System.Windows.Markup/IUriContext.xml +++ b/xml/System.Windows.Markup/IUriContext.xml @@ -52,24 +52,24 @@ Represents a service that can use application context to resolve a provided relative URI to an absolute URI. - implemented as a service enables type converters to use an application-specific context that might be able to complete a URI-type property. - - Type converters and markup extensions can query for as a service on the service context that is provided by a XAML object writer, when the XAML object writer invokes value conversion behavior. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). - - is not just for value conversion and service context. Class logic for UI elements or other classes that support containment might also implement services as a recognized pattern that child elements can call for base URI information, or store base URI information that is obtained from XAML parsing of the root element. - - In previous versions of the .NET Framework, this interface existed in the WPF-specific assembly PresentationCore. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - -## WPF Usage Notes - Example scenarios for exist in WPF. - - As an example of a value converter, the class can use a relative URI that is provided for properties such as , if is available as a service on the input. - - As an example of the element case, implements so that it can pass through base URI values when parsed, which then modifies . - + implemented as a service enables type converters to use an application-specific context that might be able to complete a URI-type property. + + Type converters and markup extensions can query for as a service on the service context that is provided by a XAML object writer, when the XAML object writer invokes value conversion behavior. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). + + is not just for value conversion and service context. Class logic for UI elements or other classes that support containment might also implement services as a recognized pattern that child elements can call for base URI information, or store base URI information that is obtained from XAML parsing of the root element. + + In previous versions of the .NET Framework, this interface existed in the WPF-specific assembly PresentationCore. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + +## WPF Usage Notes + Example scenarios for exist in WPF. + + As an example of a value converter, the class can use a relative URI that is provided for properties such as , if is available as a service on the input. + + As an example of the element case, implements so that it can pass through base URI values when parsed, which then modifies . + ]]> Type Converters and Markup Extensions for XAML diff --git a/xml/System.Windows.Markup/MarkupExtension.xml b/xml/System.Windows.Markup/MarkupExtension.xml index 6c9a0b0a2ff..949e9ab8c0c 100644 --- a/xml/System.Windows.Markup/MarkupExtension.xml +++ b/xml/System.Windows.Markup/MarkupExtension.xml @@ -48,11 +48,11 @@ ## Remarks Markup extensions return objects to callers, based on the input of string attribute values or markup elements in XAML. Markup extensions return objects in a more sophisticated way than type converters alone can accomplish. A XAML object writer invokes a type converter because a type or member has a type converter implementation associated with it. From the CLR frame of reference, this means that a type or member is attributed. From the XAML type system perspective, this means that a XAML type or a XAML member has a value for its `TypeConverter` property. The invocation of a type converter is tied to the type or property definition, and is always invoked by XAML processing for these cases. In contrast, a markup extension is more under the control of user code and user-produced markup, and can be applied whenever an application scenario demands it. A markup extension can be invoked and can be used for setting different type-member values, so long as the markup extension's return type is assignable to that value. - For information on creating a custom markup extension, see . For more information on markup extensions in general, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). If you are building on WPF and using or creating markup extensions for XAML, other relevant information can be found in the topic [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). + For information on creating a custom markup extension, see . For more information on markup extensions in general, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). If you are building on WPF and using or creating markup extensions for XAML, other relevant information can be found in the topic [Markup Extensions and WPF XAML](/dotnet/framework/wpf/advanced/markup-extensions-and-wpf-xaml). - The method of each markup extension implementation can use an at run time that can provide context. This is then queried for specific services that pass information, such as or . For more information on service contexts for a markup extension, see [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). + The method of each markup extension implementation can use an at run time that can provide context. This is then queried for specific services that pass information, such as or . For more information on service contexts for a markup extension, see [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). - Derived classes should be attributed with to inform consumers of the most specific return type available from the markup extension's implementation. + Derived classes should be attributed with to inform consumers of the most specific return type available from the markup extension's implementation. ]]> @@ -141,9 +141,9 @@ method of that markup extension and writes the result into the object graph or serialization stream. The XAML object writer passes service context to each such implementation through the `serviceProvider` parameter. + When a XAML processor processes a type node and member value that is a markup extension, it invokes the method of that markup extension and writes the result into the object graph or serialization stream. The XAML object writer passes service context to each such implementation through the `serviceProvider` parameter. - See "Notes to Implementers" section for more information on how to implement in a custom markup extension. + See "Notes to Implementers" section for more information on how to implement in a custom markup extension. ## WPF Usage Notes diff --git a/xml/System.Windows.Markup/MarkupExtensionReturnTypeAttribute.xml b/xml/System.Windows.Markup/MarkupExtensionReturnTypeAttribute.xml index 44bd0fb3e8e..8db45eb66c2 100644 --- a/xml/System.Windows.Markup/MarkupExtensionReturnTypeAttribute.xml +++ b/xml/System.Windows.Markup/MarkupExtensionReturnTypeAttribute.xml @@ -43,15 +43,15 @@ Reports the type that a markup extension can return. - derived custom class should apply this .NET Framework attribute to indicate a possible type-safe return type that is returned by its implementation. In other words, if a markup extension always returns a more specific type than type of , and casting to that type is a primary scenario, the markup extension class should attribute with and report that type. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - - For more information on patterns for implementing a custom XAML markup extension, see and [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml). - + derived custom class should apply this .NET Framework attribute to indicate a possible type-safe return type that is returned by its implementation. In other words, if a markup extension always returns a more specific type than type of , and casting to that type is a primary scenario, the markup extension class should attribute with and report that type. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + + For more information on patterns for implementing a custom XAML markup extension, see and [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml). + ]]> @@ -141,11 +141,11 @@ The return type that this attribute reports. Initializes a new instance of the class using the provided . - derived custom class should apply this attribute to indicate the type-safe return type that is returned by its implementation. - + derived custom class should apply this attribute to indicate the type-safe return type that is returned by its implementation. + ]]> @@ -192,11 +192,11 @@ Deprecated; do not use. Deprecated; do not use. - that reports a second parameter for an expression is deprecated/obsolete and should not be used. If an expression or other type or model for deferred evaluation is a possible return type, you should attribute with a return type of instead. - + that reports a second parameter for an expression is deprecated/obsolete and should not be used. If an expression or other type or model for deferred evaluation is a possible return type, you should attribute with a return type of instead. + ]]> @@ -241,11 +241,11 @@ Deprecated; do not use. Deprecated; do not use. - that reports a second parameter for an expression is deprecated and should not be used. If an expression is possible, you should attribute with a return type of instead. See . - + that reports a second parameter for an expression is deprecated and should not be used. If an expression is possible, you should attribute with a return type of instead. See . + ]]> diff --git a/xml/System.Windows.Markup/NameReferenceConverter.xml b/xml/System.Windows.Markup/NameReferenceConverter.xml index df6158d4649..9843d6214b4 100644 --- a/xml/System.Windows.Markup/NameReferenceConverter.xml +++ b/xml/System.Windows.Markup/NameReferenceConverter.xml @@ -23,19 +23,19 @@ Provides type conversion to convert a string name into an object reference to the object with that name, or to return the name of an object from the object graph. - implementation uses service from context to perform the resolution of an object by name in XAML. This is part of the relevant XAML reader and XAML writer implementations in .NET Framework XAML Services. Proper function of this converter requires that the service is available from service context. - - The implementation uses service from context to perform the resolution of a reference name for an object during save/serialization. This is part of the relevant reader and writer implementations and their context. Proper function of this converter requires that there be an underlying service available. - - This type converter implementation is atypical for the base type because it is not scoped to a discrete conversion type. It can potentially convert any object to and from a referencing name so long as that object could have a name assigned to it in XAML, and the supporting context has the necessary services to return results. - - As part of general services support, the System.Xaml base implementation of and provide and services for use by . The name basis for these services uses either `x:Name` or a attributed alias property. - + implementation uses service from context to perform the resolution of an object by name in XAML. This is part of the relevant XAML reader and XAML writer implementations in .NET Framework XAML Services. Proper function of this converter requires that the service is available from service context. + + The implementation uses service from context to perform the resolution of a reference name for an object during save/serialization. This is part of the relevant reader and writer implementations and their context. Proper function of this converter requires that there be an underlying service available. + + This type converter implementation is atypical for the base type because it is not scoped to a discrete conversion type. It can potentially convert any object to and from a referencing name so long as that object could have a name assigned to it in XAML, and the supporting context has the necessary services to return results. + + As part of general services support, the System.Xaml base implementation of and provide and services for use by . The name basis for these services uses either `x:Name` or a attributed alias property. + ]]> Type Converters and Markup Extensions for XAML @@ -105,11 +105,11 @@ if this converter can perform the conversion; otherwise, . - . Other types return `false`. - + . Other types return `false`. + ]]> @@ -147,13 +147,13 @@ if the converter can perform the conversion; otherwise, . - type returns `true`; all other `destinationType` values return `false`. - - This method returns false if `context` is `null`, or if cannot be obtained as a service from `context`. - + type returns `true`; all other `destinationType` values return `false`. + + This method returns false if `context` is `null`, or if cannot be obtained as a service from `context`. + ]]> @@ -192,18 +192,18 @@ Converts the provided object to another object, using the specified context and culture information. The returned object, which is potentially any object that is type-mapped in the relevant backing assemblies and capable of being declared in XAML with a XAML name reference. - input provides a conversion result. - + input provides a conversion result. + ]]> - is a null string or empty string. - - -or- - + is a null string or empty string. + + -or- + service is missing or invalid. is . diff --git a/xml/System.Windows.Markup/NameScopePropertyAttribute.xml b/xml/System.Windows.Markup/NameScopePropertyAttribute.xml index bd32b4b4e1e..4c88639e506 100644 --- a/xml/System.Windows.Markup/NameScopePropertyAttribute.xml +++ b/xml/System.Windows.Markup/NameScopePropertyAttribute.xml @@ -47,20 +47,20 @@ Specifies a property of the associated class that provides the XAML namescope value. - and the XAML namescope is created corresponding to the root by typical XAML processing behavior in context of a framework's programming model and application model. - - If is used, the XAML namescope property value is expected to be an object that implements and holds the actual XAML namescope and its behavior. - - There are two forms for this attribute: property name only, or type and property. The latter form should be used only for cases where the property that holds the XAML name scope is an attachable member. The attached member technique has the advantage that service classes can implement a XAML namescope concept that can support several different object types. Those object types then do not need to be explicitly related in class inheritance. - - In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - -## WPF Usage Notes - In WPF, this attribute is applied to only a single type, . In this case the attributed property is the service class and its attached property. - + and the XAML namescope is created corresponding to the root by typical XAML processing behavior in context of a framework's programming model and application model. + + If is used, the XAML namescope property value is expected to be an object that implements and holds the actual XAML namescope and its behavior. + + There are two forms for this attribute: property name only, or type and property. The latter form should be used only for cases where the property that holds the XAML name scope is an attachable member. The attached member technique has the advantage that service classes can implement a XAML namescope concept that can support several different object types. Those object types then do not need to be explicitly related in class inheritance. + + In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + +## WPF Usage Notes + In WPF, this attribute is applied to only a single type, . In this case the attributed property is the service class and its attached property. + ]]> XAML-related CLR attributes for custom types and libraries @@ -191,11 +191,11 @@ Gets the name of the property that provides the XAML namescope. A string value that is the name of the property that provides the XAML namescope. - depends on whether is set. If is null, then references a property on the type being attributed. If contains a value, then references a property on the indicated . - + depends on whether is set. If is null, then references a property on the type being attributed. If contains a value, then references a property on the indicated . + ]]> @@ -236,11 +236,11 @@ Gets the owner type of the attached property that provides the XAML namescope support. A value that is the owner type of the attached property that provides the XAML namescope support, or . - diff --git a/xml/System.Windows.Markup/NamespaceMapEntry.xml b/xml/System.Windows.Markup/NamespaceMapEntry.xml index dbe1cd28e60..e89036e614c 100644 --- a/xml/System.Windows.Markup/NamespaceMapEntry.xml +++ b/xml/System.Windows.Markup/NamespaceMapEntry.xml @@ -30,13 +30,13 @@ Provides information that the uses for mapping between an XML namespace, a CLR namespace, and the assembly that contains the relevant types for that CLR namespace. - , or from from a XAML node loop or general XAML writer frame of reference.) The XAML schema context includes API for returning its assemblies, preferred prefix mappings, and XAML namespace information. - + , or from from a XAML node loop or general XAML writer frame of reference.) The XAML schema context includes API for returning its assemblies, preferred prefix mappings, and XAML namespace information. + ]]> @@ -115,22 +115,22 @@ The CLR namespace in the assembly that contains the relevant types. Initializes a new instance of the class, using provided XML namespace, CLR namespace, and assembly information. - . Paths are specified separately; see . - + . Paths are specified separately; see . + ]]> - is - - -or- - - is - - -or- - + is + + -or- + + is + + -or- + is . @@ -168,11 +168,11 @@ Gets or sets the assembly name that contains the types in the CLR namespace. The assembly name. - . In particular, do not specify the full path, and do not include the file extension. This is analogous to the form that might be reported by . - + . In particular, do not specify the full path, and do not include the file extension. This is analogous to the form that might be reported by . + ]]> The value is being set to is . diff --git a/xml/System.Windows.Markup/NullExtension.xml b/xml/System.Windows.Markup/NullExtension.xml index 6490b35665d..1b453a11026 100644 --- a/xml/System.Windows.Markup/NullExtension.xml +++ b/xml/System.Windows.Markup/NullExtension.xml @@ -70,7 +70,7 @@ The System.Xaml assembly uses to map all types in the assembly to the XAML namespace for the XAML language (`http://schemas.microsoft.com/winfx/2006/xaml`). Typically you declare a prefix for `http://schemas.microsoft.com/winfx/2006/xaml` in a root element mapping and use the prefix `x`. ## WPF Usage Notes - For WPF dependency properties, when you set a dependency property value to `null`, you are not necessarily setting the property to its default value, even if it is a reference property. The default value of a dependency property depends on its dependency property registration. An unset value is not necessarily `null` either; see . For more information, see or [Dependency Properties Overview](/dotnet/framework/wpf/advanced/dependency-properties-overview). + For WPF dependency properties, when you set a dependency property value to `null`, you are not necessarily setting the property to its default value, even if it is a reference property. The default value of a dependency property depends on its dependency property registration. An unset value is not necessarily `null` either; see . For more information, see or [Dependency Properties Overview](/dotnet/framework/wpf/advanced/dependency-properties-overview). ]]> @@ -157,7 +157,7 @@ ## Remarks This method supports XAML processor implementations, and is not intended to be called directly. A XAML processor implementation uses this method when it creates object graphs that include an `x:Null` extension usage. This relies on general behavior for XAML processors when they process any and call its `ProvideValue` implementation. - This implementation does not rely on services that are based on the passed `serviceProvider`. It always returns a null reference regardless of context. In the .NET Framework XAML Services implementation, the value to return is obtained by referencing the static value. + This implementation does not rely on services that are based on the passed `serviceProvider`. It always returns a null reference regardless of context. In the .NET Framework XAML Services implementation, the value to return is obtained by referencing the static value. ]]> diff --git a/xml/System.Windows.Markup/ParserContext.xml b/xml/System.Windows.Markup/ParserContext.xml index 82ca1514130..c87cff4b940 100644 --- a/xml/System.Windows.Markup/ParserContext.xml +++ b/xml/System.Windows.Markup/ParserContext.xml @@ -28,17 +28,17 @@ Provides context information required by a XAML parser. - and . - - The XAML system in .NET Framework 4 uses a more sophisticated XAML type system and thus also uses a different type of context for XAML processing operations. For more information, see . - - A is typically used as an input for a call to a operation. In these cases, you are using overloads of or where supplying the provides greater control over factors such as the type mapping to XAML, or altering XML processing defaults. Using a as opposed to using default behavior is an advanced scenario. - - `xml:lang` and `xml:space` behavior is one of the aspects of a context you can override. By default, the parser context uses `en-us` based values. For more information on why the language-level context for XAML uses `en-us` rather than a culture-invariant value, see [WPF Globalization and Localization Overview](/dotnet/framework/wpf/advanced/wpf-globalization-and-localization-overview). - + and . + + The XAML system in .NET Framework 4 uses a more sophisticated XAML type system and thus also uses a different type of context for XAML processing operations. For more information, see . + + A is typically used as an input for a call to a operation. In these cases, you are using overloads of or where supplying the provides greater control over factors such as the type mapping to XAML, or altering XML processing defaults. Using a as opposed to using default behavior is an advanced scenario. + + `xml:lang` and `xml:space` behavior is one of the aspects of a context you can override. By default, the parser context uses `en-us` based values. For more information on why the language-level context for XAML uses `en-us` rather than a culture-invariant value, see [WPF Globalization and Localization Overview](/dotnet/framework/wpf/advanced/wpf-globalization-and-localization-overview). + ]]> @@ -149,11 +149,11 @@ Gets or sets the base URI for this context. The base URI, as a string. - is used to resolve external resources that are referenced in XAML. - + is used to resolve external resources that are referenced in XAML. + ]]> @@ -304,11 +304,11 @@ Gets or sets the string for this context. The string value. - . - + . + ]]> @@ -343,13 +343,13 @@ Gets the XAML namespace dictionary for this XAML parser context. The XAML namespace dictionary. - . - - The uses XAML namespace prefixes as keys and the complete XAML namespace identifier (typically a URI in string form) as values. - + . + + The uses XAML namespace prefixes as keys and the complete XAML namespace identifier (typically a URI in string form) as values. + ]]> @@ -388,11 +388,11 @@ Gets or sets the character for or this context. The character for or this context. - . - + . + ]]> xml:space Attribute diff --git a/xml/System.Windows.Markup/RuntimeNamePropertyAttribute.xml b/xml/System.Windows.Markup/RuntimeNamePropertyAttribute.xml index b7f53a8a4ef..f361ebce11e 100644 --- a/xml/System.Windows.Markup/RuntimeNamePropertyAttribute.xml +++ b/xml/System.Windows.Markup/RuntimeNamePropertyAttribute.xml @@ -59,7 +59,7 @@ In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). ## WPF Usage Notes - An example of an existing class in Windows Presentation Foundation (WPF) where the is applied is . The property on is attributed with , which results in any derived class also using as its run-time name property. + An example of an existing class in Windows Presentation Foundation (WPF) where the is applied is . The property on is attributed with , which results in any derived class also using as its run-time name property. In general, you do not typically need to apply this attribute in WPF unless you are implementing a new or -parallel framework-level class. `x:Name` should take precedence over the run-time name property if both exist as attributes on an element, and a XAML processor implementation generally throws in this case. diff --git a/xml/System.Windows.Markup/StaticExtension.xml b/xml/System.Windows.Markup/StaticExtension.xml index 9b9532ab20e..e744e2ba1dc 100644 --- a/xml/System.Windows.Markup/StaticExtension.xml +++ b/xml/System.Windows.Markup/StaticExtension.xml @@ -62,13 +62,13 @@ Implements a markup extension that returns static field and property references. - x:Static Markup Extension @@ -153,11 +153,11 @@ A string that identifies the member to make a reference to. This string uses the format prefix:typeName.fieldOrPropertyName. prefix is the mapping prefix for a XAML namespace, and is only required to reference static values that are not mapped to the default XAML namespace. Initializes a new instance of the class using the provided string. - is called when a XAML writer processes an extension usage. At that time, XAML schema context informs the type mapping and the value can be obtained. - + is called when a XAML writer processes an extension usage. At that time, XAML schema context informs the type mapping and the value can be obtained. + ]]> @@ -208,17 +208,17 @@ Gets or sets a member name string that is used to resolve a static field or property based on the service-provided type resolver. A string that identifies the member to make a reference to. - typically uses the format *prefix*`:`*typeName*`.`*fieldOrPropertyName*. (*prefix* is the mapping prefix for an XML namespace, and is only required to reference static values that are not mapped to the default XML namespace). The string can also specify only the member name, so long as is also supplied, but note that this technique will not support XML namespaces and prefixes; it is working at the type system level. - - For XAML usage information, see [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension). - - This value is not evaluated when you set it; so long as the value is not `null` it will be accepted. The actual parsing and evaluation of the value is deferred until is called during parsing. - - Under the normal scenario of use by the WPF XAML processor, the XAML processor passes a type resolver for CLR types as part of its service contract, and this resolver is used on the call. - + typically uses the format *prefix*`:`*typeName*`.`*fieldOrPropertyName*. (*prefix* is the mapping prefix for an XML namespace, and is only required to reference static values that are not mapped to the default XML namespace). The string can also specify only the member name, so long as is also supplied, but note that this technique will not support XML namespaces and prefixes; it is working at the type system level. + + For XAML usage information, see [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension). + + This value is not evaluated when you set it; so long as the value is not `null` it will be accepted. The actual parsing and evaluation of the value is deferred until is called during parsing. + + Under the normal scenario of use by the WPF XAML processor, the XAML processor passes a type resolver for CLR types as part of its service contract, and this resolver is used on the call. + ]]> Attempted to set to . @@ -266,15 +266,15 @@ Gets or sets the that defines the static member to return. The that defines the static member to return. - supports an alternate mode whereby it can return a static member based on being the simple member name and its owning type supplied as , rather than providing a full name in the form *type*`.`*member*. The type resolver still acts, but in this case the and are basically combined: `memberFullName = MemberType.FullName + "." + Member`. Note that this technique will not support XAML namespaces and prefixes; it is working against the backing type system, not the XAML type system. - - The string for typically uses the format *prefix*`:`*typeName*`.`*fieldOrPropertyName*. (*prefix* is the mapping prefix for an XML namespace, and is only required to reference static values that are not mapped to the default XML namespace). - - For XAML usage information, see [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension). - + supports an alternate mode whereby it can return a static member based on being the simple member name and its owning type supplied as , rather than providing a full name in the form *type*`.`*member*. The type resolver still acts, but in this case the and are basically combined: `memberFullName = MemberType.FullName + "." + Member`. Note that this technique will not support XAML namespaces and prefixes; it is working against the backing type system, not the XAML type system. + + The string for typically uses the format *prefix*`:`*typeName*`.`*fieldOrPropertyName*. (*prefix* is the mapping prefix for an XML namespace, and is only required to reference static values that are not mapped to the default XML namespace). + + For XAML usage information, see [x:Static Markup Extension](/dotnet/framework/xaml-services/x-static-markup-extension). + ]]> Attempted to set to . @@ -317,26 +317,26 @@ Returns an object value to set on the property where you apply this extension. For , the return value is the static value that is evaluated for the requested static member. The static value to set on the property where the extension is applied. - . Under the normal scenario of use by the default XAML readers and XAML writers, a suitable service provider is available. An invalid XAML schema context might have the side effect of breaking type mapping and thus the service. - - In .NET Framework 4, supports an alternate mode whereby it can return a static member based on being the simple member name and its owning type supplied as , rather than providing a full name in the form *type*`.`*member*. The type resolver still acts, but in this case the and are basically combined: `memberFullName = MemberType.FullName + "." + Member`. - + . Under the normal scenario of use by the default XAML readers and XAML writers, a suitable service provider is available. An invalid XAML schema context might have the side effect of breaking type mapping and thus the service. + + In .NET Framework 4, supports an alternate mode whereby it can return a static member based on being the simple member name and its owning type supplied as , rather than providing a full name in the form *type*`.`*member*. The type resolver still acts, but in this case the and are basically combined: `memberFullName = MemberType.FullName + "." + Member`. + ]]> The value for the extension is at the time of evaluation. - Some part of the string did not parse properly - - -or- - - did not provide a service for - - -or- - + Some part of the string did not parse properly + + -or- + + did not provide a service for + + -or- + value did not resolve to a static member. is . diff --git a/xml/System.Windows.Markup/TemplateKeyConverter.xml b/xml/System.Windows.Markup/TemplateKeyConverter.xml index d8b8c169dca..a517b09f9c9 100644 --- a/xml/System.Windows.Markup/TemplateKeyConverter.xml +++ b/xml/System.Windows.Markup/TemplateKeyConverter.xml @@ -24,11 +24,11 @@ Implements a type converter for objects, which deliberately have no type conversion pathways. The type converter enforces and reports that behavior. - type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. - + type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, the and methods always return `false`. The and methods always throw an exception. + ]]> @@ -97,11 +97,11 @@ Determines whether an object of the specified type can be converted to an instance of . Always returns . - . - + . + ]]> @@ -139,11 +139,11 @@ Determines whether an instance of can be converted to the specified type. Always returns . - . - + . + ]]> @@ -183,11 +183,11 @@ Attempts to convert the specified object (string) to a . Always throws an exception. - . - + . + ]]> @@ -231,11 +231,11 @@ Attempts to convert a to the specified type, using the specified context. Always throws an exception. - . - + . + ]]> diff --git a/xml/System.Windows.Markup/TypeExtension.xml b/xml/System.Windows.Markup/TypeExtension.xml index cf59f1b08d5..0e503578f4a 100644 --- a/xml/System.Windows.Markup/TypeExtension.xml +++ b/xml/System.Windows.Markup/TypeExtension.xml @@ -68,7 +68,7 @@ For XAML usage information, see [x:Type Markup Extension](/dotnet/framework/xaml-services/x-type-markup-extension). > [!NOTE] -> The `{x:Type}` functionality is generally for user code invocation from markup. For code that is implementing XAML support, type resolution services come from and are related to the implementation of the acting XAML schema context. Do not attempt to reference as a substitute for a service provider; the context you pass in might not be valid for a type resolution, and attempts to call without valid services will fail. +> The `{x:Type}` functionality is generally for user code invocation from markup. For code that is implementing XAML support, type resolution services come from and are related to the implementation of the acting XAML schema context. Do not attempt to reference as a substitute for a service provider; the context you pass in might not be valid for a type resolution, and attempts to call without valid services will fail. ## WPF Usage Notes Type references are commonly used for style, template, and databinding feature areas in WPF, when these features are referenced by XAML. @@ -161,7 +161,7 @@ is called on this extension, when XAML is parsed and with available service contexts active. At this time the `typeName` is expected to be resolvable as a type within a XAML schema context, and that type is returned. + This value is not evaluated when you set it in the constructor. If the value is not `null`, the value will be initially accepted. The actual parsing and evaluation of the value is deferred until is called on this extension, when XAML is parsed and with available service contexts active. At this time the `typeName` is expected to be resolvable as a type within a XAML schema context, and that type is returned. ]]> @@ -321,9 +321,9 @@ signature constructor, this value will be `null`. This property will not be reset when is called. If you want the true type represented you should always call rather than check this property. + Unless this instance was deliberately instantiated with the signature constructor, this value will be `null`. This property will not be reset when is called. If you want the true type represented you should always call rather than check this property. - This property is settable per usual rules regarding markup extension usage. However, if you are setting with a , then the purpose of this markup extension is irrelevant, because the same is returned from a call. + This property is settable per usual rules regarding markup extension usage. However, if you are setting with a , then the purpose of this markup extension is irrelevant, because the same is returned from a call. ]]> diff --git a/xml/System.Windows.Markup/ValueSerializer.xml b/xml/System.Windows.Markup/ValueSerializer.xml index a5c9ae850eb..16d9aa412fb 100644 --- a/xml/System.Windows.Markup/ValueSerializer.xml +++ b/xml/System.Windows.Markup/ValueSerializer.xml @@ -434,19 +434,19 @@ for a property, or for a type that is used as the value for a property, is indicated by applying the attribute on the property or type declaration. The method is a utility method that reads the CLR type system information and returns a new class based on the attribute if found on the property, or then if found on the property's type. `null` might be returned if no such serializer exists. `null` might also be returned if a type or property is deliberately attributed with a null-value . + A for a property, or for a type that is used as the value for a property, is indicated by applying the attribute on the property or type declaration. The method is a utility method that reads the CLR type system information and returns a new class based on the attribute if found on the property, or then if found on the property's type. `null` might be returned if no such serializer exists. `null` might also be returned if a type or property is deliberately attributed with a null-value . - Another mode that supports is returning the internal `TypeConverterValueSerializer` class, which is a implementation that wraps a and translates the `Convert` methods to `Convert*String` methods (for instance is called with input of the type, and translates to . This is done only in cases where all of the following are true: + Another mode that supports is returning the internal `TypeConverterValueSerializer` class, which is a implementation that wraps a and translates the `Convert` methods to `Convert*String` methods (for instance is called with input of the type, and translates to . This is done only in cases where all of the following are true: - A is found on the relevant property, or the relevant property's type. - The indicated can be successfully constructed. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. > [!NOTE] > The following are special cases: types return a ; types return an internal but functional serializer (`StringValueSerializer`). @@ -494,19 +494,19 @@ for a type is indicated by applying the attribute on the type declaration. The method is a utility method that reads the CLR type system information and returns a new class based on the attribute if found on the specified `type`. `null` might be returned if no such serializer exists. `null` might also be returned if a type is deliberately attributed with a null-value . + A for a type is indicated by applying the attribute on the type declaration. The method is a utility method that reads the CLR type system information and returns a new class based on the attribute if found on the specified `type`. `null` might be returned if no such serializer exists. `null` might also be returned if a type is deliberately attributed with a null-value . - Another mode that supports is returning the internal `TypeConverterValueSerializer` class, which is a implementation that wraps a and translates the `Convert` methods to `Convert*String` methods (for instance is called with input of the type, and translates to . This is done only in cases where all of the following are true: + Another mode that supports is returning the internal `TypeConverterValueSerializer` class, which is a implementation that wraps a and translates the `Convert` methods to `Convert*String` methods (for instance is called with input of the type, and translates to . This is done only in cases where all of the following are true: - A is found on `type`. - The indicated can be successfully constructed. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. -- The returns `true` for , called referencing the type. +- The returns `true` for , called referencing the type. > [!NOTE] > The following are special cases: types return a ; types return an internal but functional serializer (`StringValueSerializer`). @@ -556,11 +556,11 @@ . The implementation would typically also rely on the `descriptor`, but might implement special behavior for certain contexts. + Rather than relying purely on attributes reported in the CLR type system, this overload uses the `context` as a service, and calls the service's implementation of . The implementation would typically also rely on the `descriptor`, but might implement special behavior for certain contexts. This method should be called when the caller has an available from a service. This will ensure that the correct is returned for the specific context. - If the context returns `null` from its for your specified `descriptor`, or if the context you specify is `null`, then behavior is identical to calling the overload. + If the context returns `null` from its for your specified `descriptor`, or if the context you specify is `null`, then behavior is identical to calling the overload. ]]> @@ -607,11 +607,11 @@ . The implementation would typically also rely on the `type`, but might implement special behavior for certain contexts. + Rather than relying purely on attributes reported in the CLR type system, this overload uses the `context` as a service, and calls the service's implementation of . The implementation would typically also rely on the `type`, but might implement special behavior for certain contexts. This method should be called when the caller has an available from a service. This will ensure that the correct is returned for the specific context. - If the context returns `null` from its for your specified `type`, or if the context you specify is `null`, then behavior is identical to calling the overload. + If the context returns `null` from its for your specified `type`, or if the context you specify is `null`, then behavior is identical to calling the overload. ]]> @@ -663,7 +663,7 @@ Overriding this method is an advanced scenario. Overriding should only be necessary if you are implementing a system where CLR type system ownertype-property relationships available to a XAML schema context do not report enough information. ## WPF Usage Notes - The WPF property system implements an internal value serializer that overrides because a dependency property has a concept that it can have added owners. WPF expressions also have special internal handling. + The WPF property system implements an internal value serializer that overrides because a dependency property has a concept that it can have added owners. WPF expressions also have special internal handling. ]]> diff --git a/xml/System.Windows.Markup/ValueSerializerAttribute.xml b/xml/System.Windows.Markup/ValueSerializerAttribute.xml index 825f02e1f58..97fd7edf4d9 100644 --- a/xml/System.Windows.Markup/ValueSerializerAttribute.xml +++ b/xml/System.Windows.Markup/ValueSerializerAttribute.xml @@ -73,18 +73,18 @@ Identifies the class that a type or property should use when it is serialized. - attribute at the type level. For a property, you apply the attribute at the property level. Application at the property level potentially overrides any previous declaration for that property's type as applied at the type level. - - A can be associated with an attachable member by applying the attribute on the static `get` accessor method for the attachable member. - - Value serialization is also applicable for enumerations, interfaces, and structures, but not for delegates. - - In early versions of .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, was moved to the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). - + For a type, you apply the attribute at the type level. For a property, you apply the attribute at the property level. Application at the property level potentially overrides any previous declaration for that property's type as applied at the type level. + + A can be associated with an attachable member by applying the attribute on the static `get` accessor method for the attachable member. + + Value serialization is also applicable for enumerations, interfaces, and structures, but not for delegates. + + In early versions of .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, was moved to the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). + ]]> @@ -156,11 +156,11 @@ The assembly qualified type name string for the class to use. Initializes a new instance of the class, using an assembly qualified type name string. - for the requested . - + for the requested . + ]]> diff --git a/xml/System.Windows.Markup/XData.xml b/xml/System.Windows.Markup/XData.xml index ab66d5f65ef..d3e65ee0a73 100644 --- a/xml/System.Windows.Markup/XData.xml +++ b/xml/System.Windows.Markup/XData.xml @@ -32,7 +32,7 @@ is the XAML content property for . To read values from out of a XAML node stream where `XData` is returned, get the property value. + is the XAML content property for . To read values from out of a XAML node stream where `XData` is returned, get the property value. Encoding considerations are declared at top-level XML, and are generally UTF-8 by default. @@ -106,7 +106,7 @@ is the XAML content property for . To read values from out of a XAML node stream where `XData` is returned, get the property value. + is the XAML content property for . To read values from out of a XAML node stream where `XData` is returned, get the property value. ]]> diff --git a/xml/System.Windows.Markup/XamlDesignerSerializationManager.xml b/xml/System.Windows.Markup/XamlDesignerSerializationManager.xml index c6dea5b953a..ab1dff86e2d 100644 --- a/xml/System.Windows.Markup/XamlDesignerSerializationManager.xml +++ b/xml/System.Windows.Markup/XamlDesignerSerializationManager.xml @@ -24,13 +24,13 @@ Provides services for XAML serialization by XAML designers or other callers that require advanced serialization. - attempts to optimize access to services that are called frequently during the serialization process. - - A is also used as an input for certain specialized `ShouldSerialize` methods on WPF classes such as , and for an overload of . - + attempts to optimize access to services that are called frequently during the serialization process. + + A is also used as an input for certain specialized `ShouldSerialize` methods on WPF classes such as , and for an overload of . + ]]> diff --git a/xml/System.Windows.Markup/XamlParseException.xml b/xml/System.Windows.Markup/XamlParseException.xml index 1d7e7bb311e..f5635fbf479 100644 --- a/xml/System.Windows.Markup/XamlParseException.xml +++ b/xml/System.Windows.Markup/XamlParseException.xml @@ -34,7 +34,7 @@ is used only for the WPF-implemented XAML parser that performs the XAML parsing and loading for WPF applications. Specifically, the exception is only relevant when an application targets .NET Framework 3.0 and .NET Framework 3.5. The exception can also originate from user code in run-time calls to APIs that hook up the WPF-implemented XAML parser to load XAML from within a running WPF application (for example, calls to ). + is used only for the WPF-implemented XAML parser that performs the XAML parsing and loading for WPF applications. Specifically, the exception is only relevant when an application targets .NET Framework 3.0 and .NET Framework 3.5. The exception can also originate from user code in run-time calls to APIs that hook up the WPF-implemented XAML parser to load XAML from within a running WPF application (for example, calls to ). For .NET Framework 4, the exception that typically reports XAML processing exceptions is defined in a different namespace () and a different assembly (System.Xaml). @@ -382,7 +382,7 @@ sets a object with all the exception object data targeted for serialization. During deserialization, the exception is reconstituted from the transmitted over the stream. + sets a object with all the exception object data targeted for serialization. During deserialization, the exception is reconstituted from the transmitted over the stream. ]]> diff --git a/xml/System.Windows.Markup/XamlReader.xml b/xml/System.Windows.Markup/XamlReader.xml index 152514e552b..d3a004ef32f 100644 --- a/xml/System.Windows.Markup/XamlReader.xml +++ b/xml/System.Windows.Markup/XamlReader.xml @@ -27,15 +27,15 @@ methods are static, but the asynchronous methods are not static and require an instance of the class to use. + The synchronous methods are static, but the asynchronous methods are not static and require an instance of the class to use. - The output of the `Load` methods is a single object, which represents the root object of a created object tree or object graph. Object graphs that are created by are typically added to the existing object tree of a WPF application at run time. Otherwise the new object graph is considered disconnected for purposes of the WPF application model. This means that it does not render, and cannot be accessed using any of the object tree techniques as applied to the WPF application's main object tree (for example, the APIs , , ). For more information on object tree concepts, see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + The output of the `Load` methods is a single object, which represents the root object of a created object tree or object graph. Object graphs that are created by are typically added to the existing object tree of a WPF application at run time. Otherwise the new object graph is considered disconnected for purposes of the WPF application model. This means that it does not render, and cannot be accessed using any of the object tree techniques as applied to the WPF application's main object tree (for example, the APIs , , ). For more information on object tree concepts, see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). supports the following primary scenarios: -- **Cloning/object factory**: Without additional mechanisms, a reference type generally cannot be included in more than one position in a WPF object tree. (Examples of additional mechanisms that offer support for sharing or re-use in WPF include objects that are based on , or support for commonly shareable objects such as that are referenced as an item from a .) One way to clone an object that is already in the object tree is to serialize the object using . You then use the serialized string as input for a call to , with a stream or as an intermediary. +- **Cloning/object factory**: Without additional mechanisms, a reference type generally cannot be included in more than one position in a WPF object tree. (Examples of additional mechanisms that offer support for sharing or re-use in WPF include objects that are based on , or support for commonly shareable objects such as that are referenced as an item from a .) One way to clone an object that is already in the object tree is to serialize the object using . You then use the serialized string as input for a call to , with a stream or as an intermediary. -- **Constructing objects based on just-in-time information**: There are often other ways to have late-binding or user-supplied input change the state of existing objects. For example you could use the same value to set more than one property, or use data binding. But if you have a scenario where even the type of object to create is only determinable at run time or with user interaction, then creating such an object by building up a string for input is often a useful technique. +- **Constructing objects based on just-in-time information**: There are often other ways to have late-binding or user-supplied input change the state of existing objects. For example you could use the same value to set more than one property, or use data binding. But if you have a scenario where even the type of object to create is only determinable at run time or with user interaction, then creating such an object by building up a string for input is often a useful technique. - **Using existing resource techniques**: The type is used frequently in other frameworks or technologies for transferring data or objects across application boundaries or for similar situations. You can then use the techniques to store or obtain XAML-formatted data that you eventually use to create an object as part of your application. @@ -68,7 +68,7 @@ If you are targeting .NET Framework 4, the external API is the same, but parts of the implementation are built on the .NET Framework 4 general XAML implementation in the System.Xaml assembly, which improves many of the technical and reporting aspects of parsing XAML. Targeting .NET Framework 4 necessarily entails including System.Xaml as a reference, and details of implementation such as the exceptions reported may come from System.Xaml defined types. ## Examples - The following example converts a into a string using the class. The string is then loaded back into a using the static method on the class. + The following example converts a into a string using the class. The string is then loaded back into a using the static method on the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: @@ -133,7 +133,7 @@ is an asynchronous operation; therefore, some loading may occur before the operation is aborted. + is an asynchronous operation; therefore, some loading may occur before the operation is aborted. ]]> @@ -211,7 +211,7 @@ into a using the class. The stream is then loaded back into a using the static method on the class. + The following example saves a into a using the class. The stream is then loaded back into a using the static method on the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: @@ -298,7 +298,7 @@ into a string using the class. The string is then loaded back into a using the static method on the class. + The following example converts a into a string using the class. The string is then loaded back into a using the static method on the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: @@ -500,7 +500,7 @@ You typically would assign the returned object to some location in your WPF application's object tree, with the knowledge that content might still be filling in and might cause incremental layout updates if the entire content is exposed as part of the UI. For this reason it is typical to isolate or virtualize any asynchronously loaded objects from XAML, and to use application-specific logic or application state to notify when is handled. - In order for to load XAML input asynchronously, the root element in the XAML input must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML input root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is processed as a synchronous load (see ). + In order for to load XAML input asynchronously, the root element in the XAML input must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML input root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is processed as a synchronous load (see ). Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. @@ -550,9 +550,9 @@ ## Remarks An asynchronous XAML load operation will initially return an object that is purely the root object. Asynchronously, XAML parsing then continues, and any child objects are filled in under the root. This is in contrast to the typical WPF XAML processing behavior and its interaction with WPF concepts of object lifetime. In the typical (non-async) interaction, all properties of an object including all child collections are filled before returning an element and reporting it as loaded. That behavior equates to a bottom-up methodology for creating the tree where the root object is the last object to become available. - You typically would assign the returned object from to some location in your application's object tree, with the knowledge that content might still be filling in and might cause incremental layout updates if the entire content is exposed as part of the UI. For this reason it is typical to isolate or virtualize any asynchronously loaded objects from XAML, and to use application-specific logic or application state to notify when is handled. + You typically would assign the returned object from to some location in your application's object tree, with the knowledge that content might still be filling in and might cause incremental layout updates if the entire content is exposed as part of the UI. For this reason it is typical to isolate or virtualize any asynchronously loaded objects from XAML, and to use application-specific logic or application state to notify when is handled. - In order for to load XAML input asynchronously, the root element in the XAML markup must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML markup root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is instead processed as a synchronous load (see ). + In order for to load XAML input asynchronously, the root element in the XAML markup must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML markup root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is instead processed as a synchronous load (see ). Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. @@ -639,7 +639,7 @@ You typically would assign the returned object to some location in your application's object tree, with the knowledge that content might still be filling in and might cause incremental layout updates if the entire content is exposed as part of the UI. For this reason it is typical to isolate or virtualize any asynchronously loaded objects from XAML, and to use application-specific logic or application state to notify when is handled. - In order for to load markup asynchronously, the root element in the XAML markup must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML markup root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is processed as a synchronous load (see ). + In order for to load markup asynchronously, the root element in the XAML markup must contain the attribute and value `x:SynchronousMode="Async"`. The value is treated as case sensitive. If the XAML markup root does not contain `x:SynchronousMode="Async"`, no exception is thrown, and the call is processed as a synchronous load (see ). Only one asynchronous load operation per instance of the class can be performed at a time. If more than one asynchronous operation is attempted on the same instance of the class an is thrown. @@ -801,7 +801,7 @@ internally after creating a stream from the string. See for additional information such as possible exceptions. + The implementation calls internally after creating a stream from the string. See for additional information such as possible exceptions. ]]> @@ -876,7 +876,7 @@ internally after creating a stream from the string. See for additional information such as possible exceptions. + The implementation calls internally after creating a stream from the string. See for additional information such as possible exceptions. ]]> diff --git a/xml/System.Windows.Markup/XamlSetMarkupExtensionAttribute.xml b/xml/System.Windows.Markup/XamlSetMarkupExtensionAttribute.xml index 276a2df9c30..fa9a3f79503 100644 --- a/xml/System.Windows.Markup/XamlSetMarkupExtensionAttribute.xml +++ b/xml/System.Windows.Markup/XamlSetMarkupExtensionAttribute.xml @@ -29,11 +29,11 @@ Indicates that a class can use a markup extension to provide a value, and references a handler to use for markup extension set operations. - load or parse, or a / sequence, will use this attribute and invoke the named callback as part of the operation whenever writing the object node based on a markup extension usage. - + load or parse, or a / sequence, will use this attribute and invoke the named callback as part of the operation whenever writing the object node based on a markup extension usage. + ]]> @@ -69,11 +69,11 @@ The name of the handler to use for markup extension set operations. Initializes a new instance of the class. - delegate with event data constraint. - + delegate with event data constraint. + ]]> @@ -110,12 +110,12 @@ Gets the name of the handler to use for markup extension set operations. The name of the handler to use for markup extension set operations. - delegate with the event data constraint. - +The`XamlSetMarkupExtensionHandler` handler should be based on a generic delegate with the event data constraint. + ]]> diff --git a/xml/System.Windows.Markup/XamlSetTypeConverterAttribute.xml b/xml/System.Windows.Markup/XamlSetTypeConverterAttribute.xml index c1a3f069adb..092225660ac 100644 --- a/xml/System.Windows.Markup/XamlSetTypeConverterAttribute.xml +++ b/xml/System.Windows.Markup/XamlSetTypeConverterAttribute.xml @@ -29,11 +29,11 @@ Indicates that a class can use a type converter to provide a value, and references a handler to use for type converter setting cases. - load or parse, or a / sequence, will use this attribute and invoke the named callback as part of the operation whenever writing an object node based on an attributed and invoked type converter. - + load or parse, or a / sequence, will use this attribute and invoke the named callback as part of the operation whenever writing an object node based on an attributed and invoked type converter. + ]]> @@ -70,11 +70,11 @@ The name of the handler to use for type converter setting operations. Initializes a new instance of the class. - delegate with event data constraint. - + delegate with event data constraint. + ]]> diff --git a/xml/System.Windows.Markup/XamlSetTypeConverterEventArgs.xml b/xml/System.Windows.Markup/XamlSetTypeConverterEventArgs.xml index b486d7d9706..ba4715ebd98 100644 --- a/xml/System.Windows.Markup/XamlSetTypeConverterEventArgs.xml +++ b/xml/System.Windows.Markup/XamlSetTypeConverterEventArgs.xml @@ -23,13 +23,13 @@ Provides data for callbacks that are invoked when a XAML writer sets a value using a type converter call. - delegate, with event data constraint. - - Callbacks for type converter usages are referenced by applied at the class level (for example on class in WPF). A custom might also reference a callback through the value. - + delegate, with event data constraint. + + Callbacks for type converter usages are referenced by applied at the class level (for example on class in WPF). A custom might also reference a callback through the value. + ]]> diff --git a/xml/System.Windows.Markup/XamlSetValueEventArgs.xml b/xml/System.Windows.Markup/XamlSetValueEventArgs.xml index 4266d683a0e..72fa2191f78 100644 --- a/xml/System.Windows.Markup/XamlSetValueEventArgs.xml +++ b/xml/System.Windows.Markup/XamlSetValueEventArgs.xml @@ -23,13 +23,13 @@ Provides data for callbacks that are invoked when a sets certain values. - provides data specifically for callbacks associated with a or its settings. The callbacks use the generic delegate, with event data constraint. - - This event data class is potentially used for set-value callback scenarios that are not specifically markup extensions or type converters acting. There are also two subclasses of for more specific XAML value setting cases, and the specific event data class constrains that event data. is used for the markup extension callback case and is used for the type converter callback case. An example of a scenario where the set-value operation is not a markup extension or type converter is the DataTrigger scenario in WPF data binding. - + provides data specifically for callbacks associated with a or its settings. The callbacks use the generic delegate, with event data constraint. + + This event data class is potentially used for set-value callback scenarios that are not specifically markup extensions or type converters acting. There are also two subclasses of for more specific XAML value setting cases, and the specific event data class constrains that event data. is used for the markup extension callback case and is used for the type converter callback case. An example of a scenario where the set-value operation is not a markup extension or type converter is the DataTrigger scenario in WPF data binding. + ]]> @@ -90,13 +90,13 @@ When overridden in a derived class, provides a way to invoke a callback as defined on a base class of the current acting type. - might be invoked as part of a `ReceiveMarkupExtension` implementation, in cases where the implementation is expecting a particular markup extension as the primary case but wants a way to attempt alternative cases without immediately failing. This is useful for dealing with a markup extension that might itself be extensible. - - The "current acting type information" is only available internally, and refers to the type of the instance where the set operation is occurring. and both override this method by using the internal current acting type information. - + might be invoked as part of a `ReceiveMarkupExtension` implementation, in cases where the implementation is expecting a particular markup extension as the primary case but wants a way to attempt alternative cases without immediately failing. This is useful for dealing with a markup extension that might itself be extensible. + + The "current acting type information" is only available internally, and refers to the type of the instance where the set operation is occurring. and both override this method by using the internal current acting type information. + ]]> @@ -141,11 +141,11 @@ if the values were useful and calling is not necessary; otherwise, . - or has code pathways that has processed the set value attempt. - + or has code pathways that has processed the set value attempt. + ]]> diff --git a/xml/System.Windows.Markup/XamlTypeMapper.xml b/xml/System.Windows.Markup/XamlTypeMapper.xml index 2b9fb5a8cb8..384de6dc930 100644 --- a/xml/System.Windows.Markup/XamlTypeMapper.xml +++ b/xml/System.Windows.Markup/XamlTypeMapper.xml @@ -31,10 +31,10 @@ can be used to provide the XAML parser with custom mapping information through a more direct technique than the application of values on the assembly code. This might be useful for consolidation of all CLR namespaces in an assembly, or for referencing types that are XAML-ready in an existing assembly without having to recompile it just to add attributing. - You typically create a instance in order to specify the property value for a . The in turn can be used as the context for a call. + You typically create a instance in order to specify the property value for a . The in turn can be used as the context for a call. ## Default Mapper - You can obtain a default mapper using the static property. The default mapper only works on a default assembly list. No specific information about assemblies (as is specified in constructors) is used. + You can obtain a default mapper using the static property. The default mapper only works on a default assembly list. No specific information about assemblies (as is specified in constructors) is used. ]]> @@ -152,7 +152,7 @@ is a programmatic way to add a mapping. For example, the different parts of the following XAML mapping instruction correspond to the parameters of the : + is a programmatic way to add a mapping. For example, the different parts of the following XAML mapping instruction correspond to the parameters of the : ``` @@ -210,9 +210,9 @@ always returns `false`. + If not overridden by a subclass, always returns `false`. - When overridden by a subclass, the behavior should be that should return `true` if the internal type can be accessed; otherwise, `false`. + When overridden by a subclass, the behavior should be that should return `true` if the internal type can be accessed; otherwise, `false`. ]]> diff --git a/xml/System.Windows.Markup/XamlWriter.xml b/xml/System.Windows.Markup/XamlWriter.xml index 2a20dfefe77..5895a6a46a3 100644 --- a/xml/System.Windows.Markup/XamlWriter.xml +++ b/xml/System.Windows.Markup/XamlWriter.xml @@ -24,21 +24,21 @@ Provides a single static method (multiple overloads) that can be used for limited XAML serialization of provided run-time objects into XAML markup. - is not permitted when running in partial trust. This includes from XBAPs. - - - -## Examples - The following example serializes a into a string using the class. The string is then deserialized back into a using the static method on the class. - + is not permitted when running in partial trust. This includes from XBAPs. + + + +## Examples + The following example serializes a into a string using the class. The string is then deserialized back into a using the static method on the class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: + ]]> @@ -90,21 +90,21 @@ Returns a XAML string that serializes the specified object and its properties. A XAML string that can be written to a stream or file. The logical tree of all elements that fall under the provided element will be serialized. - is not permitted when running in partial trust. - - - -## Examples - The following example serializes a into a string using the class. The string is then deserialized back into a using the static method on the class. - + is not permitted when running in partial trust. + + + +## Examples + The following example serializes a into a string using the class. The string is then deserialized back into a using the static method on the class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: + ]]> @@ -151,21 +151,21 @@ Destination stream for the serialized XAML information. Saves XAML information into a specified stream to serialize the specified object and its properties. - is not permitted when running in partial trust. - - - -## Examples - The following example serializes a into a using the class. The stream is then deserialized back into a using the static method on the class. - + is not permitted when running in partial trust. + + + +## Examples + The following example serializes a into a using the class. The stream is then deserialized back into a using the static method on the class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Markup/XamlReader/Overview/Window1.xaml.cs" id="Snippetxamlreaderloadxmlreader"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Markup/XamlReader/Overview/window1.xaml.vb" id="Snippetxamlreaderloadxmlreader"::: + ]]> @@ -212,13 +212,13 @@ A instance as the destination where the serialized XAML information is written. Saves XAML information as the source for a provided object. The output of the can then be used to serialize the provided object and its properties. - is not permitted when running in partial trust. - + is not permitted when running in partial trust. + ]]> @@ -265,13 +265,13 @@ A custom serialization implementation. Saves XAML information into a custom serializer. The output of the serializer can then be used to serialize the provided object and its properties. - is not permitted when running in partial trust. - + is not permitted when running in partial trust. + ]]> @@ -318,13 +318,13 @@ Writer to use to write the serialized XAML information. Saves XAML information as the source for a provided object. The output of the can then be used to serialize the provided object and its properties. - is not permitted when running in partial trust. - + is not permitted when running in partial trust. + ]]> diff --git a/xml/System.Windows.Markup/XmlAttributeProperties.xml b/xml/System.Windows.Markup/XmlAttributeProperties.xml index fccbb5ef56a..1f9e5c2a85d 100644 --- a/xml/System.Windows.Markup/XmlAttributeProperties.xml +++ b/xml/System.Windows.Markup/XmlAttributeProperties.xml @@ -28,7 +28,7 @@ , , and and . + This class implements attached property support for , , and and . These properties are generally only used by the WPF XAML parser implementation for .NET Framework 3.0 and .NET Framework 3.5. Actual user code attached property calls from XAML markup is not the primary scenario. The properties are implemented as attached properties primarily so that the properties can better support the property inheritance concept for dependency properties through all possible object graphs. As such, this is really an infrastructure support class. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). diff --git a/xml/System.Windows.Markup/XmlLanguage.xml b/xml/System.Windows.Markup/XmlLanguage.xml index ac2d535adc2..5536e100e21 100644 --- a/xml/System.Windows.Markup/XmlLanguage.xml +++ b/xml/System.Windows.Markup/XmlLanguage.xml @@ -92,7 +92,7 @@ corresponding to , whose result is . + This value is in effect the corresponding to , whose result is . ]]> @@ -129,7 +129,7 @@ can be produced, this method raises an exception. If you do not wish to handle exceptions, call instead. + If no equivalent can be produced, this method raises an exception. If you do not wish to handle exceptions, call instead. ]]> @@ -224,9 +224,9 @@ is equal to then this method will return . + If this is equal to then this method will return . - This method finds the registered matching the longest-possible prefix of this . If that registered is neutral ( is `true`), then this method relies on a call to to map from a neutral to a specific one. + This method finds the registered matching the longest-possible prefix of this . If that registered is neutral ( is `true`), then this method relies on a call to to map from a neutral to a specific one. ]]> @@ -269,9 +269,9 @@ . + This property may return a normalized version of the originally-specified string as provided to . - This property may also return if an empty string was provided to . + This property may also return if an empty string was provided to . ]]> @@ -314,7 +314,7 @@ value of the current . + This returns the value of the current . ]]> diff --git a/xml/System.Windows.Markup/XmlLanguageConverter.xml b/xml/System.Windows.Markup/XmlLanguageConverter.xml index 1137c50317a..b981a179010 100644 --- a/xml/System.Windows.Markup/XmlLanguageConverter.xml +++ b/xml/System.Windows.Markup/XmlLanguageConverter.xml @@ -24,11 +24,11 @@ Provides type conversion for the class. - as their underlying type. - + as their underlying type. + ]]> @@ -100,11 +100,11 @@ if this converter can perform the conversion; otherwise, . - . - + . + ]]> @@ -144,11 +144,11 @@ if this converter can perform the conversion; otherwise, . - or `destinationType` of . - + or `destinationType` of . + ]]> @@ -189,13 +189,13 @@ Converts the specified string value to the type supported by this converter. An object that represents the converted value. - . - - Internally, this method calls . See for additional exception information. - + . + + Internally, this method calls . See for additional exception information. + ]]> Conversion could not be performed. @@ -245,11 +245,11 @@ Converts the specified to the specified type. An object that represents the converted value. - , this method returns the value of the provided . For `destinationType` this method returns an instance that is useful for serialization. Other `destinationType` inputs throw exceptions. - + , this method returns the value of the provided . For `destinationType` this method returns an instance that is useful for serialization. Other `destinationType` inputs throw exceptions. + ]]> Conversion could not be performed. diff --git a/xml/System.Windows.Markup/XmlnsDefinitionAttribute.xml b/xml/System.Windows.Markup/XmlnsDefinitionAttribute.xml index b849f7b020c..777a9591246 100644 --- a/xml/System.Windows.Markup/XmlnsDefinitionAttribute.xml +++ b/xml/System.Windows.Markup/XmlnsDefinitionAttribute.xml @@ -54,7 +54,7 @@ To find the appropriate types that back object element usages or object references in a XAML file, a XAML processor searches each referenced assembly for applications. Generally the XAML schema context supplies this information. - In a XAML file, if the `xmlns` attribute for an object element or property element matches the in the , the XAML processor uses the and stored in the for type resolution against types in the assembly. + In a XAML file, if the `xmlns` attribute for an object element or property element matches the in the , the XAML processor uses the and stored in the for type resolution against types in the assembly. In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, is in the System.Xaml assembly. For more information, see [Types Migrated from WPF to System.Xaml](/dotnet/framework/xaml-services/types-migrated-from-wpf-to-system-xaml). diff --git a/xml/System.Windows.Markup/XmlnsDictionary.xml b/xml/System.Windows.Markup/XmlnsDictionary.xml index 3fb1a42277f..f95a470ed5b 100644 --- a/xml/System.Windows.Markup/XmlnsDictionary.xml +++ b/xml/System.Windows.Markup/XmlnsDictionary.xml @@ -43,13 +43,13 @@ Represents a dictionary that contains xmlns mappings for XAML namespaces in WPF. - maps XAML namespace prefixes to the complete XAML namespace URI. For XAML usage in applications and XAML namespaces in general, the URI is often not a schema-style URI that includes `http://`. It is instead a user-defined mapping to a CLR namespace and assembly. That assembly contains the backing types being referred to. For details, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). - - The adds the concept of scope for a XAML namespace. A default might contain prefix keys and XML namespace URI values. The scope concept in parallels the XML concept that a prefix might be redefined. If so, the redefinition only applies at that level or below in a DOM view of the XML (the previous definition applies at higher level in the DOM). The scope concept is mostly abstracted away in the API, such that you can call APIs such as without being concerned about scope. However, does expose and so that a custom implementation that changes scope can synchronize with the scope for the . - + maps XAML namespace prefixes to the complete XAML namespace URI. For XAML usage in applications and XAML namespaces in general, the URI is often not a schema-style URI that includes `http://`. It is instead a user-defined mapping to a CLR namespace and assembly. That assembly contains the backing types being referred to. For details, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). + + The adds the concept of scope for a XAML namespace. A default might contain prefix keys and XML namespace URI values. The scope concept in parallels the XML concept that a prefix might be redefined. If so, the redefinition only applies at that level or below in a DOM view of the XML (the previous definition applies at higher level in the DOM). The scope concept is mostly abstracted away in the API, such that you can call APIs such as without being concerned about scope. However, does expose and so that a custom implementation that changes scope can synchronize with the scope for the . + ]]> @@ -116,11 +116,11 @@ The dictionary on which to base the new . Initializes a new instance of the class by using the specified dictionary as a copy source. - , which is set to `false` in the new instance. - + , which is set to `false` in the new instance. + ]]> @@ -171,11 +171,11 @@ The XAML namespace URI the prefix maps to. Adds a prefix-URI pair to this . - . - + . + ]]> @@ -450,11 +450,11 @@ Looks up the XAML namespace that corresponds to the default XAML namespace. The namespace that corresponds to the default XML namespace if one exists; otherwise, . - @@ -487,11 +487,11 @@ Returns a dictionary enumerator that iterates through this . The dictionary enumerator for this dictionary. - @@ -524,11 +524,11 @@ Returns an enumerator that iterates through this . The enumerator for this dictionary. - collection. - + collection. + ]]> @@ -648,11 +648,11 @@ if the size is fixed; otherwise, . - is `true`. - + is `true`. + ]]> @@ -694,11 +694,11 @@ if the dictionary is read-only; otherwise, . - is read-only after is called. - + is read-only after is called. + ]]> @@ -780,16 +780,16 @@ The corresponding XAML namespace URI. To be added. - is not a string - - -or- - + is not a string + + -or- + The value to set is not a string. - is - - -or- - + is + + -or- + The value to set is . @@ -835,10 +835,10 @@ The corresponding XML namespace URI. To be added. - is - - -or- - + is + + -or- + The value to set is . @@ -940,11 +940,11 @@ Returns the prefix that corresponds to the specified XAML namespace URI. The XML prefix that corresponds to the given namespace; otherwise, . - @@ -978,11 +978,11 @@ Pops the scope of the . - that also works at an element scope level. - + that also works at an element scope level. + ]]> The is sealed. @@ -1015,11 +1015,11 @@ Pushes the scope of the . - that also works at an element scope level. - + that also works at an element scope level. + ]]> The is sealed. @@ -1067,11 +1067,11 @@ The prefix key to remove. Removes the item with the specified prefix key from the . - . - + . + ]]> The is sealed. @@ -1137,11 +1137,11 @@ Locks the dictionary so that it cannot be changed. - to a property (typically on a ). Attempting to modify the dictionary after the is sealed throws an . - + to a property (typically on a ). Attempting to modify the dictionary after the is sealed throws an . + ]]> @@ -1180,11 +1180,11 @@ if the dictionary is sealed; otherwise, . - . - + . + ]]> diff --git a/xml/System.Windows.Media.Animation/Animatable.xml b/xml/System.Windows.Media.Animation/Animatable.xml index 74822e4d4cb..34c87b0c86d 100644 --- a/xml/System.Windows.Media.Animation/Animatable.xml +++ b/xml/System.Windows.Media.Animation/Animatable.xml @@ -168,9 +168,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock will return `null`. Note also that the event will not be called if the effective duration of the clock is forever. In that case, the user will need to determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock will return `null`. Note also that the event will not be called if the effective duration of the clock is forever. In that case, the user will need to determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks will also be disconnected and garbage collected. @@ -242,7 +242,7 @@ that is greater than zero, the animation begins after that amount of time has elapsed from the time the next frame is rendered. + If the animation has a that is greater than zero, the animation begins after that amount of time has elapsed from the time the next frame is rendered. ]]> @@ -294,16 +294,16 @@ that is greater than zero, the animation begins after that amount of time has elapsed from the time the next frame is rendered. + If the animation has a that is greater than zero, the animation begins after that amount of time has elapsed from the time the next frame is rendered. ## Using the Compose HandoffBehavior When you apply a , , or to a property using the , any objects previously associated with that property continue to consume system resources; the timing system will not remove these clocks automatically. To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock will return `null`. Note also that the event will not be called if the effective duration of the clock is forever. In that case, the user will need to determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock will return `null`. Note also that the event will not be called if the effective duration of the clock is forever. In that case, the user will need to determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks will also be disconnected and garbage collected. @@ -353,7 +353,7 @@ method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. + The method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. ]]> @@ -397,9 +397,9 @@ is `true`. + This method will return `false` when is `true`. - Do not call this method directly (except when calling base in an implementation). This method is called internally by (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). + Do not call this method directly (except when calling base in an implementation). This method is called internally by (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). ]]> @@ -448,7 +448,7 @@ . + If the specified property is not animated, this method returns the same result as . @@ -543,7 +543,7 @@ class uses the method to determine if a property should be serialized. + The class uses the method to determine if a property should be serialized. ]]> diff --git a/xml/System.Windows.Media.Animation/AnimationException.xml b/xml/System.Windows.Media.Animation/AnimationException.xml index ea16271f4a6..f17ba64e7d6 100644 --- a/xml/System.Windows.Media.Animation/AnimationException.xml +++ b/xml/System.Windows.Media.Animation/AnimationException.xml @@ -31,11 +31,11 @@ The exception that is thrown when an error occurs while animating a property. - and settings. - + and settings. + ]]> diff --git a/xml/System.Windows.Media.Animation/AnimationTimeline.xml b/xml/System.Windows.Media.Animation/AnimationTimeline.xml index 87dfd6b36bd..6fe6e9e5585 100644 --- a/xml/System.Windows.Media.Animation/AnimationTimeline.xml +++ b/xml/System.Windows.Media.Animation/AnimationTimeline.xml @@ -113,7 +113,7 @@ method and should not be called directly by your code. + This method is called by the method and should not be called directly by your code. ]]> @@ -155,7 +155,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -192,7 +192,7 @@ method with a type-safe implementation. + This method shadows the inherited method with a type-safe implementation. ]]> @@ -270,7 +270,7 @@ and should not be called directly from your code. + This method provides the implementation for and should not be called directly from your code. ]]> diff --git a/xml/System.Windows.Media.Animation/BackEase.xml b/xml/System.Windows.Media.Animation/BackEase.xml index af7e465db80..666c12e96d8 100644 --- a/xml/System.Windows.Media.Animation/BackEase.xml +++ b/xml/System.Windows.Media.Animation/BackEase.xml @@ -26,7 +26,7 @@ property value on an animation. The following graph demonstrate the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control when the "back up" behavior occurs in an animation by specifying the property value on an animation. The following graph demonstrate the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![BackEase EasingMode graphs.](~/add/media/backease-graph.png "BackEase EasingMode graphs.") @@ -35,7 +35,7 @@ ![BackEase formula.](~/add/media/backease-formula.png "BackEase formula.") > [!NOTE] -> Because this animation causes values to retract before progressing, the animation might interpolate into negative numbers unexpectedly. This can cause errors when animating properties that do not allow negative numbers. For example, if you apply this animation to the of an object (e.g. from 0 to 200 with an of ), the animation will attempt to interpolate through negative numbers for which will throw an error. +> Because this animation causes values to retract before progressing, the animation might interpolate into negative numbers unexpectedly. This can cause errors when animating properties that do not allow negative numbers. For example, if you apply this animation to the of an object (e.g. from 0 to 200 with an of ), the animation will attempt to interpolate through negative numbers for which will throw an error. There are several other easing functions besides . In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -199,12 +199,12 @@ In addition to using the easing functions included in the run-time, you can crea . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -246,9 +246,9 @@ In addition to using the easing functions included in the run-time, you can crea case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/BeginStoryboard.xml b/xml/System.Windows.Media.Animation/BeginStoryboard.xml index 12725965cee..b3e475f2f6c 100644 --- a/xml/System.Windows.Media.Animation/BeginStoryboard.xml +++ b/xml/System.Windows.Media.Animation/BeginStoryboard.xml @@ -37,12 +37,12 @@ action with an or a to apply animations to their target properties and start them. begins a by calling on its reference when triggered. + Use a action with an or a to apply animations to their target properties and start them. begins a by calling on its reference when triggered. When you begin a on a property that is already being animated by another , the property of determines how the animation proceeds. ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a that was declared in markup interactively, you must set the property of its . You can then control the by using a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a that was declared in markup interactively, you must set the property of its . You can then control the by using a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. > [!NOTE] > In code, you may use the interactive methods of the class to control a that was applied using a . As is the case when using objects, you must give the a name for its to be interactively controllable. @@ -136,9 +136,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -188,7 +188,7 @@ , set the property of its and use a object like , , or to reference this name. If the of is unspecified, the cannot be interactively affected after it is begun; furthermore, when the ends or enters its Fill period, the animation clocks are disposed of. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise interactively control a , set the property of its and use a object like , , or to reference this name. If the of is unspecified, the cannot be interactively affected after it is begun; furthermore, when the ends or enters its Fill period, the animation clocks are disposed of. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ]]> diff --git a/xml/System.Windows.Media.Animation/BooleanAnimationBase.xml b/xml/System.Windows.Media.Animation/BooleanAnimationBase.xml index a18168e22a6..768e60479f8 100644 --- a/xml/System.Windows.Media.Animation/BooleanAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/BooleanAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/BooleanAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/BooleanAnimationUsingKeyFrames.xml index f0e880a634d..b53c783fa17 100644 --- a/xml/System.Windows.Media.Animation/BooleanAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/BooleanAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ]]> @@ -198,7 +198,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -237,9 +237,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -278,7 +278,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -317,9 +317,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -425,11 +425,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -468,9 +468,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -514,7 +514,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/BooleanKeyFrame.xml b/xml/System.Windows.Media.Animation/BooleanKeyFrame.xml index 465dec00a0a..2f16178afde 100644 --- a/xml/System.Windows.Media.Animation/BooleanKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/BooleanKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/BooleanKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/BooleanKeyFrameCollection.xml index 52776346683..29c57bc9528 100644 --- a/xml/System.Windows.Media.Animation/BooleanKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/BooleanKeyFrameCollection.xml @@ -35,34 +35,34 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreBooleanKeyFrames - - -``` - - -## XAML Values - *oneOrMoreBooleanKeyFrames* - One or more objects, declared using object element syntax. - - - -## Examples - The following example demonstrates how to use a animation. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/BooleanAnimationBase/Overview/BooleanAnimationUsingKeyFramesExample.xaml" id="Snippetbooleananimationusingkeyframeswholepage"::: - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreBooleanKeyFrames + + +``` + + +## XAML Values + *oneOrMoreBooleanKeyFrames* + One or more objects, declared using object element syntax. + + + +## Examples + The following example demonstrates how to use a animation. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/BooleanAnimationBase/Overview/BooleanAnimationUsingKeyFramesExample.xaml" id="Snippetbooleananimationusingkeyframeswholepage"::: + ]]> @@ -187,13 +187,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -228,13 +228,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -270,13 +270,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -314,13 +314,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -516,15 +516,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -560,13 +560,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -603,21 +603,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -653,15 +653,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -798,11 +798,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -840,10 +840,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/BounceEase.xml b/xml/System.Windows.Media.Animation/BounceEase.xml index 4f8a539619a..c204035af91 100644 --- a/xml/System.Windows.Media.Animation/BounceEase.xml +++ b/xml/System.Windows.Media.Animation/BounceEase.xml @@ -26,7 +26,7 @@ using different values of , where *f*(*t*) represents the animation progress and *t* represents time. + The following graph demonstrates using different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![BounceEase EasingMode graphs.](~/add/media/bounceease-graph.png "BounceEase EasingMode graphs.") @@ -262,12 +262,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -309,9 +309,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/ByteAnimation.xml b/xml/System.Windows.Media.Animation/ByteAnimation.xml index e9198f580dc..0a4e01ab624 100644 --- a/xml/System.Windows.Media.Animation/ByteAnimation.xml +++ b/xml/System.Windows.Media.Animation/ByteAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -279,17 +279,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -376,7 +376,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -507,17 +507,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -609,7 +609,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -649,7 +649,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -697,7 +697,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -745,17 +745,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/ByteAnimationBase.xml b/xml/System.Windows.Media.Animation/ByteAnimationBase.xml index 642da99287a..6ba89ac45a9 100644 --- a/xml/System.Windows.Media.Animation/ByteAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/ByteAnimationBase.xml @@ -94,7 +94,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -269,7 +269,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/ByteAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/ByteAnimationUsingKeyFrames.xml index d2f62e2ee54..a1e3a4230f4 100644 --- a/xml/System.Windows.Media.Animation/ByteAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/ByteAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -396,9 +396,9 @@ (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). + Do not call this method directly (except when calling base in an implementation). This method is called internally by (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). - For more information, see . + For more information, see . ]]> @@ -437,11 +437,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -480,9 +480,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -526,7 +526,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -631,7 +631,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/ByteKeyFrame.xml b/xml/System.Windows.Media.Animation/ByteKeyFrame.xml index bb693adff25..5e499f02ed7 100644 --- a/xml/System.Windows.Media.Animation/ByteKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/ByteKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/ByteKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/ByteKeyFrameCollection.xml index d42065d64d4..5edad5815fe 100644 --- a/xml/System.Windows.Media.Animation/ByteKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/ByteKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreByteKeyFrames - - -``` - - -## XAML Values - *oneOrMoreByteKeyFrames* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreByteKeyFrames + + +``` + + +## XAML Values + *oneOrMoreByteKeyFrames* + One or more objects, declared using object element syntax. + ]]> @@ -180,13 +180,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -264,13 +264,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -308,13 +308,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -554,13 +554,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -596,21 +596,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -646,15 +646,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -791,11 +791,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -833,10 +833,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/CharAnimationBase.xml b/xml/System.Windows.Media.Animation/CharAnimationBase.xml index 6fb2ebc89a9..2f1cdb0af8f 100644 --- a/xml/System.Windows.Media.Animation/CharAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/CharAnimationBase.xml @@ -94,7 +94,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -269,7 +269,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/CharAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/CharAnimationUsingKeyFrames.xml index b13e74410b6..b64d1d091ee 100644 --- a/xml/System.Windows.Media.Animation/CharAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/CharAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ]]> @@ -198,7 +198,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -237,9 +237,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -278,7 +278,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -317,9 +317,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -425,11 +425,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -468,9 +468,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -514,7 +514,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/CharKeyFrame.xml b/xml/System.Windows.Media.Animation/CharKeyFrame.xml index ea2645c6d9a..9713609101a 100644 --- a/xml/System.Windows.Media.Animation/CharKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/CharKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/CharKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/CharKeyFrameCollection.xml index 007a5c97d62..c1099cc5fcb 100644 --- a/xml/System.Windows.Media.Animation/CharKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/CharKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreCharKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreCharKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreCharKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreCharKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -509,15 +509,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -552,13 +552,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -594,21 +594,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -644,15 +644,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -789,11 +789,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -831,10 +831,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/CircleEase.xml b/xml/System.Windows.Media.Animation/CircleEase.xml index 81bf7fbc93d..e2ccb657f29 100644 --- a/xml/System.Windows.Media.Animation/CircleEase.xml +++ b/xml/System.Windows.Media.Animation/CircleEase.xml @@ -26,7 +26,7 @@ . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates, or both by specifying the . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![CircleEase EasingMode graphs.](~/add/media/circleease-graph.png "CircleEase EasingMode graphs.") @@ -126,12 +126,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -173,9 +173,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/Clock.xml b/xml/System.Windows.Media.Animation/Clock.xml index 0b5d2d53048..2510ae5433a 100644 --- a/xml/System.Windows.Media.Animation/Clock.xml +++ b/xml/System.Windows.Media.Animation/Clock.xml @@ -29,11 +29,11 @@ ## Remarks A , by itself, doesn't actually do anything other than describe a segment of time. It's the timeline's object that does the real work: it maintains timing-related run-time state for the timeline. - In most cases, a clock is created automatically for your timeline. When you animate by using a or the method, clocks are automatically created for your timelines and animations and applied to their targeted properties. For examples, see [How to: Animate a Property by Using a Storyboard](/dotnet/framework/wpf/graphics-multimedia/how-to-animate-a-property-by-using-a-storyboard) and [How to: Animate a Property Without Using a Storyboard](/dotnet/framework/wpf/graphics-multimedia/how-to-animate-a-property-without-using-a-storyboard). + In most cases, a clock is created automatically for your timeline. When you animate by using a or the method, clocks are automatically created for your timelines and animations and applied to their targeted properties. For examples, see [How to: Animate a Property by Using a Storyboard](/dotnet/framework/wpf/graphics-multimedia/how-to-animate-a-property-by-using-a-storyboard) and [How to: Animate a Property Without Using a Storyboard](/dotnet/framework/wpf/graphics-multimedia/how-to-animate-a-property-without-using-a-storyboard). - You can also create a explicitly by using the method. In performance-intensive scenarios, such as animating large numbers of similar objects, managing your own use can provide performance benefits. + You can also create a explicitly by using the method. In performance-intensive scenarios, such as animating large numbers of similar objects, managing your own use can provide performance benefits. - Clocks are arranged in trees that match the structure of the objects tree from which they are created. The root clock of such a timing tree can be interactively manipulated (paused, resumed, stopped, and so on) by retrieving its . Non-root clocks cannot be directly controlled. + Clocks are arranged in trees that match the structure of the objects tree from which they are created. The root clock of such a timing tree can be interactively manipulated (paused, resumed, stopped, and so on) by retrieving its . Non-root clocks cannot be directly controlled. Once created, a clock cannot be modified (but it can be manipulated). @@ -301,7 +301,7 @@ ## Remarks A clock's first iteration has a value of 1. - If this clock's timeline has an setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. + If this clock's timeline has an setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. Regardless of its current iteration, seeking a clock returns its current iteration to 1. Restarting a clock also returns its current iteration to 1. @@ -347,9 +347,9 @@ normalized by the of this clock's . + The value of this property indicates the normalized by the of this clock's . - A clock that is has a of 1.0. + A clock that is has a of 1.0. ## Using a Timeline as a Timer A timeline's clock will only progress when there's an event handler associated with it or (in the case of an object) it is associated with a property. For this reason (and others), it's not recommended that you use a as a timer. @@ -440,7 +440,7 @@ ## Remarks Use the event when you want to be notified if when the clock starts, stops, or fills. The parameter of the event handler is the whose state was invalidated. - Pausing a does not change its . To be notified when a clock becomes paused, use the event. + Pausing a does not change its . To be notified when a clock becomes paused, use the event. Although this event occurs when the becomes invalid, that doesn't necessarily mean the changed: a that switches from to and then back to in the same tick will cause this event to fire, but its property won't actually change. @@ -526,7 +526,7 @@ becomes invalid when the clock progresses. The following interactive operations also trigger the CurrentTimeInvalidated event: , , , , and . + A clock's becomes invalid when the clock progresses. The following interactive operations also trigger the CurrentTimeInvalidated event: , , , , and . ]]> @@ -592,7 +592,7 @@ within a is an example of creating a that would have an external time source (a video clip for example) which may require synchronization with other timelines within the . See for more information. + Media being played using within a is an example of creating a that would have an external time source (a video clip for example) which may require synchronization with other timelines within the . See for more information. ]]> @@ -629,7 +629,7 @@ method and should not be called directly from your code. + This method is used in the implementation of the method and should not be called directly from your code. ]]> @@ -742,7 +742,7 @@ method. + For more information about natural duration, see the method. ]]> diff --git a/xml/System.Windows.Media.Animation/ClockCollection.xml b/xml/System.Windows.Media.Animation/ClockCollection.xml index 5d7f1a0858e..143dc810460 100644 --- a/xml/System.Windows.Media.Animation/ClockCollection.xml +++ b/xml/System.Windows.Media.Animation/ClockCollection.xml @@ -533,11 +533,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -573,13 +573,13 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - - Example - + instance is cast to an interface. + + Example + ]]> diff --git a/xml/System.Windows.Media.Animation/ClockController.xml b/xml/System.Windows.Media.Animation/ClockController.xml index 76df6e57a9b..6ee89db43c3 100644 --- a/xml/System.Windows.Media.Animation/ClockController.xml +++ b/xml/System.Windows.Media.Animation/ClockController.xml @@ -65,9 +65,9 @@ to behave as though its object's were set to the time of the next tick. The timeline's actual setting is ignored (but not changed). + This method causes the target to behave as though its object's were set to the time of the next tick. The timeline's actual setting is ignored (but not changed). - This method changes the target clock's to . The method does not resume a paused clock. + This method changes the target clock's to . The method does not resume a paused clock. This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events will also not be raised until then. Calling this method triggers the and events. @@ -143,7 +143,7 @@ regardless of its current state, and pausing a clock does not change its current state. A clock can be paused while , , or . The only way to unpause a clock is by using the method. Pausing a clock implicitly pauses its children. + You can pause a regardless of its current state, and pausing a clock does not change its current state. A clock can be paused while , , or . The only way to unpause a clock is by using the method. Pausing a clock implicitly pauses its children. Calling this method when the target clock is already paused has no effect. @@ -228,7 +228,7 @@ regardless of its current state, and pausing or resuming a clock does not change its current state. A clock can be paused while , , or . The only way to resume a paused clock is by using the method. Resuming a clock implicitly resumes its children. Calling this method on a clock that is not paused has no effect. + You can pause or resume a regardless of its current state, and pausing or resuming a clock does not change its current state. A clock can be paused while , , or . The only way to resume a paused clock is by using the method. Resuming a clock implicitly resumes its children. Calling this method on a clock that is not paused has no effect. Resuming a paused clock triggers the event. @@ -272,9 +272,9 @@ or settings of this clock's timeline into account: the clock is treated as though its timeline has a of 1 and no . + Seek operations do not take the or settings of this clock's timeline into account: the clock is treated as though its timeline has a of 1 and no . - This method changes the clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then. + This method changes the clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then. Seeking a storyboard triggers the and events. @@ -329,20 +329,20 @@ or settings of this clock's timeline into account: the clock is treated as though its timeline has a of 1 and no . + Seek operations do not take the or settings of this clock's timeline into account: the clock is treated as though its timeline has a of 1 and no . - aligns the seeked time of the clock with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen will not reflect these changes until the screen updates. + aligns the seeked time of the clock with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen will not reflect these changes until the screen updates. If the target clock has children, their current time is updated accordingly. - This method changes the clock's to . + This method changes the clock's to . Seeking a storyboard triggers the and events. ## Examples - The following example demonstrates both the and methods of a . + The following example demonstrates both the and methods of a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Animation/ClockController/Remove/SeekAlignedToLastTickExample.cs" id="Snippetclockcontrollerseekexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Animation/ClockController/Remove/seekalignedtolasttickexample.vb" id="Snippetclockcontrollerseekexample"::: @@ -381,9 +381,9 @@ setting of its . If the timeline's property is set to , the clock fills; if the property is set to , the clock stops. + This method advances the target clock's current time to the end of its active period; the clock's behavior at this point is specified by the setting of its . If the timeline's property is set to , the clock fills; if the property is set to , the clock stops. - This method has an effect only if the target clock's is . + This method has an effect only if the target clock's is . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then. @@ -425,7 +425,7 @@ ## Remarks Setting this property has no effect until the next tick. If you set this property and then get its value before the next tick occurs, you'll get the old value. This property will return the new value after the next tick. - Setting this property does not change the value of the underlying timeline's . + Setting this property does not change the value of the underlying timeline's . Setting this property triggers the target clock's event. @@ -464,9 +464,9 @@ to . + This method changes the target clock's to . - A clock can be restarted by using the , , or method. + A clock can be restarted by using the , , or method. This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then. diff --git a/xml/System.Windows.Media.Animation/ColorAnimation.xml b/xml/System.Windows.Media.Animation/ColorAnimation.xml index b49f4872cb3..9cf516afd77 100644 --- a/xml/System.Windows.Media.Animation/ColorAnimation.xml +++ b/xml/System.Windows.Media.Animation/ColorAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -368,7 +368,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -499,17 +499,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -613,7 +613,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -653,7 +653,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -701,7 +701,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -749,17 +749,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/ColorAnimationBase.xml b/xml/System.Windows.Media.Animation/ColorAnimationBase.xml index b143e852275..16f9d2c9d75 100644 --- a/xml/System.Windows.Media.Animation/ColorAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/ColorAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/ColorAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/ColorAnimationUsingKeyFrames.xml index b78ac1c222f..6804edf285e 100644 --- a/xml/System.Windows.Media.Animation/ColorAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/ColorAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are four types of classes, one for each supported interpolation method: , , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/ColorKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/ColorKeyFrameCollection.xml index d747b429dfd..e579080659a 100644 --- a/xml/System.Windows.Media.Animation/ColorKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/ColorKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreColorKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreColorKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreColorKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreColorKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -788,15 +788,15 @@ Gets a value that indicates whether access to the collection is synchronized (thread-safe). - if access to the collection is synchronized (thread-safe); otherwise, . - + if access to the collection is synchronized (thread-safe); otherwise, . + . - @@ -834,10 +834,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/ControllableStoryboardAction.xml b/xml/System.Windows.Media.Animation/ControllableStoryboardAction.xml index 8ca50d5c45d..d5bf6f38a41 100644 --- a/xml/System.Windows.Media.Animation/ControllableStoryboardAction.xml +++ b/xml/System.Windows.Media.Animation/ControllableStoryboardAction.xml @@ -29,7 +29,7 @@ ## Remarks ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ]]> diff --git a/xml/System.Windows.Media.Animation/CubicEase.xml b/xml/System.Windows.Media.Animation/CubicEase.xml index 1ed9fee3461..cc881fe5642 100644 --- a/xml/System.Windows.Media.Animation/CubicEase.xml +++ b/xml/System.Windows.Media.Animation/CubicEase.xml @@ -23,33 +23,33 @@ Represents an easing function that creates an animation that accelerates and/or decelerates using the formula *f*(*t*) = *t*3. - . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. - - ![CubicEase EasingMode graphs.](~/add/media/cubicease-graph.png "CubicEase EasingMode graphs.") - - The formula used for this function is the following. - - *f*(*t*) = *t*3 - + . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + + ![CubicEase EasingMode graphs.](~/add/media/cubicease-graph.png "CubicEase EasingMode graphs.") + + The formula used for this function is the following. + + *f*(*t*) = *t*3 + There are several other easing functions besides . - In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . - -## XAML Object Element Usage - + In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . + +## XAML Object Element Usage + ```xaml - -``` - - - -## Examples - The following example applies a easing function to a to create a decelerating animation. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/CubicEase/Overview/window1.xaml" id="Snippetcubicease"::: - + +``` + + + +## Examples + The following example applies a easing function to a to create a decelerating animation. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/CubicEase/Overview/window1.xaml" id="Snippetcubicease"::: + ]]> @@ -121,19 +121,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> @@ -168,13 +168,13 @@ Provides the logic portion of the easing function that you can override to produce the mode of the custom easing function. A double that represents the transformed progress. - case of . - - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. - + case of . + + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + ]]> diff --git a/xml/System.Windows.Media.Animation/DecimalAnimation.xml b/xml/System.Windows.Media.Animation/DecimalAnimation.xml index 1e978aa1bf5..e04388b004f 100644 --- a/xml/System.Windows.Media.Animation/DecimalAnimation.xml +++ b/xml/System.Windows.Media.Animation/DecimalAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -356,7 +356,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -487,17 +487,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -589,7 +589,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -629,7 +629,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -677,7 +677,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -725,17 +725,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/DecimalAnimationBase.xml b/xml/System.Windows.Media.Animation/DecimalAnimationBase.xml index fde0b99d78e..7b8a7bbb8ad 100644 --- a/xml/System.Windows.Media.Animation/DecimalAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/DecimalAnimationBase.xml @@ -94,7 +94,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -269,7 +269,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/DecimalAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/DecimalAnimationUsingKeyFrames.xml index ceb370d4b26..3f6a17007dc 100644 --- a/xml/System.Windows.Media.Animation/DecimalAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/DecimalAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -510,7 +510,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -615,7 +615,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/DecimalKeyFrame.xml b/xml/System.Windows.Media.Animation/DecimalKeyFrame.xml index 10e2c1dd571..813d0a3a2c9 100644 --- a/xml/System.Windows.Media.Animation/DecimalKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DecimalKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/DecimalKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/DecimalKeyFrameCollection.xml index 154c5fbb30b..73729eb3595 100644 --- a/xml/System.Windows.Media.Animation/DecimalKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/DecimalKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreDecimalKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreDecimalKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreDecimalKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreDecimalKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -306,13 +306,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -509,15 +509,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -552,13 +552,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -594,21 +594,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -644,15 +644,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -789,11 +789,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -831,10 +831,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/DiscreteBooleanKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteBooleanKeyFrame.xml index 108ea30c879..a8c0af0bc10 100644 --- a/xml/System.Windows.Media.Animation/DiscreteBooleanKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteBooleanKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteByteKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteByteKeyFrame.xml index 6bcb4deb922..3100fca1d39 100644 --- a/xml/System.Windows.Media.Animation/DiscreteByteKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteByteKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteCharKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteCharKeyFrame.xml index e62e3e88879..55ee11861d2 100644 --- a/xml/System.Windows.Media.Animation/DiscreteCharKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteCharKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteColorKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteColorKeyFrame.xml index 03db24876e4..14a50f6dce1 100644 --- a/xml/System.Windows.Media.Animation/DiscreteColorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteColorKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteDecimalKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteDecimalKeyFrame.xml index f78b83cc372..1764c7eaa59 100644 --- a/xml/System.Windows.Media.Animation/DiscreteDecimalKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteDecimalKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteDoubleKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteDoubleKeyFrame.xml index 4b49e9e2cb4..4d2581e3181 100644 --- a/xml/System.Windows.Media.Animation/DiscreteDoubleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteDoubleKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteInt16KeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteInt16KeyFrame.xml index 0026cd60f33..36a6d2a6899 100644 --- a/xml/System.Windows.Media.Animation/DiscreteInt16KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteInt16KeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. diff --git a/xml/System.Windows.Media.Animation/DiscreteInt32KeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteInt32KeyFrame.xml index fa0b014bcf4..447e6d2a2cc 100644 --- a/xml/System.Windows.Media.Animation/DiscreteInt32KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteInt32KeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteInt64KeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteInt64KeyFrame.xml index bc51a5d7377..7bd070ca75f 100644 --- a/xml/System.Windows.Media.Animation/DiscreteInt64KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteInt64KeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteMatrixKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteMatrixKeyFrame.xml index 9777f84841b..c909616cffb 100644 --- a/xml/System.Windows.Media.Animation/DiscreteMatrixKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteMatrixKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteObjectKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteObjectKeyFrame.xml index 095a1ff2284..eb3c70b7072 100644 --- a/xml/System.Windows.Media.Animation/DiscreteObjectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteObjectKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscretePoint3DKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscretePoint3DKeyFrame.xml index 3522570731f..a824d892924 100644 --- a/xml/System.Windows.Media.Animation/DiscretePoint3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscretePoint3DKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - object in conjunction with a object to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. - + object in conjunction with a object to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscretePointKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscretePointKeyFrame.xml index 0cb0b0cbf0b..19fec8b68f0 100644 --- a/xml/System.Windows.Media.Animation/DiscretePointKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscretePointKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteQuaternionKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteQuaternionKeyFrame.xml index da503662676..80b478f8f8e 100644 --- a/xml/System.Windows.Media.Animation/DiscreteQuaternionKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteQuaternionKeyFrame.xml @@ -24,13 +24,13 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteRectKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteRectKeyFrame.xml index 2b1983e8a61..a2caa571467 100644 --- a/xml/System.Windows.Media.Animation/DiscreteRectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteRectKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteRotation3DKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteRotation3DKeyFrame.xml index 33caabf258a..c10c368584d 100644 --- a/xml/System.Windows.Media.Animation/DiscreteRotation3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteRotation3DKeyFrame.xml @@ -24,13 +24,13 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a object to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - + in conjunction with a object to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteSingleKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteSingleKeyFrame.xml index d0d115e7324..434d3b8f1f3 100644 --- a/xml/System.Windows.Media.Animation/DiscreteSingleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteSingleKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteSizeKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteSizeKeyFrame.xml index 2cba265ef0b..b88a486b7d7 100644 --- a/xml/System.Windows.Media.Animation/DiscreteSizeKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteSizeKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteStringKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteStringKeyFrame.xml index 9ccb1130dbc..a86eef1804e 100644 --- a/xml/System.Windows.Media.Animation/DiscreteStringKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteStringKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteThicknessKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteThicknessKeyFrame.xml index 2e60446c46f..872a2caf0f4 100644 --- a/xml/System.Windows.Media.Animation/DiscreteThicknessKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteThicknessKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteVector3DKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteVector3DKeyFrame.xml index 00896947156..6782745bf26 100644 --- a/xml/System.Windows.Media.Animation/DiscreteVector3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteVector3DKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no interpolation). In other words, the animated property does not change until the key frame's key time is reached, at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DiscreteVectorKeyFrame.xml b/xml/System.Windows.Media.Animation/DiscreteVectorKeyFrame.xml index 618a81b2580..28d9adfd1d2 100644 --- a/xml/System.Windows.Media.Animation/DiscreteVectorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DiscreteVectorKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using discrete interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Discrete key frames like create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value. + ]]> diff --git a/xml/System.Windows.Media.Animation/DoubleAnimation.xml b/xml/System.Windows.Media.Animation/DoubleAnimation.xml index a188ad3568b..46e3faa3c7c 100644 --- a/xml/System.Windows.Media.Animation/DoubleAnimation.xml +++ b/xml/System.Windows.Media.Animation/DoubleAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,18 +259,18 @@ ## Remarks Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. - The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -357,7 +357,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -488,18 +488,18 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -591,7 +591,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -631,7 +631,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -679,7 +679,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -727,18 +727,18 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/DoubleAnimationBase.xml b/xml/System.Windows.Media.Animation/DoubleAnimationBase.xml index e6d6f859cea..e583f13148f 100644 --- a/xml/System.Windows.Media.Animation/DoubleAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/DoubleAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/DoubleAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/DoubleAnimationUsingKeyFrames.xml index 21a9ce8409d..491a590cbe7 100644 --- a/xml/System.Windows.Media.Animation/DoubleAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/DoubleAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,9 +429,9 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. ]]> @@ -470,9 +470,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -516,7 +516,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -621,7 +621,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/DoubleAnimationUsingPath.xml b/xml/System.Windows.Media.Animation/DoubleAnimationUsingPath.xml index 285e361ecc7..369fd200853 100644 --- a/xml/System.Windows.Media.Animation/DoubleAnimationUsingPath.xml +++ b/xml/System.Windows.Media.Animation/DoubleAnimationUsingPath.xml @@ -27,7 +27,7 @@ uses linear interpolation over a specified . + uses linear interpolation over a specified . is similar to except that it uses a to interpolate over two or more values rather then between only two values like . Although is used for most simple animations involving a Double value, is particularly well suited for animating the position of an object on the screen. @@ -112,7 +112,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -186,7 +186,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -272,7 +272,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -357,7 +357,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/DoubleAnimationUsingPath/PathGeometry/doubleanimationusingpathattributesyntaxexample.xaml" id="Snippetdoubleanimationusingpathattributesyntaxexample"::: - For more information about markup syntax, see [Path Markup Syntax](/dotnet/framework/wpf/graphics-multimedia/path-markup-syntax). For more examples of creating a path using markup or code, see . + For more information about markup syntax, see [Path Markup Syntax](/dotnet/framework/wpf/graphics-multimedia/path-markup-syntax). For more examples of creating a path using markup or code, see . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/DoubleKeyFrame.xml b/xml/System.Windows.Media.Animation/DoubleKeyFrame.xml index bd57a2ef750..de29a6a3eb6 100644 --- a/xml/System.Windows.Media.Animation/DoubleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/DoubleKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/DoubleKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/DoubleKeyFrameCollection.xml index 2f68dcf7878..db71dcf0f77 100644 --- a/xml/System.Windows.Media.Animation/DoubleKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/DoubleKeyFrameCollection.xml @@ -35,34 +35,34 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreDoubleKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreDoubleKeyFrameObjectElements* - One or more objects, declared using object element syntax. - - - -## Examples - The following example demonstrates how to use a animation. - - :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/BooleanAnimationBase/Overview/AltDoubleAnimationUsingKeyFramesExample.xaml" id="Snippetaltdoubleanimationusingkeyframeswholepage"::: - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreDoubleKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreDoubleKeyFrameObjectElements* + One or more objects, declared using object element syntax. + + + +## Examples + The following example demonstrates how to use a animation. + + :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/BooleanAnimationBase/Overview/AltDoubleAnimationUsingKeyFramesExample.xaml" id="Snippetaltdoubleanimationusingkeyframeswholepage"::: + ]]> KeyFrame Animation Sample @@ -186,13 +186,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -227,13 +227,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -268,13 +268,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -312,13 +312,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is equal to . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is equal to . + + This method determines equality by calling . + ]]> @@ -515,15 +515,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -558,13 +558,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -600,21 +600,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -650,15 +650,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is equal to . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is equal to . + + This method determines equality by calling . + ]]> @@ -795,11 +795,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -837,10 +837,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/EasingByteKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingByteKeyFrame.xml index c6672530827..93176e88300 100644 --- a/xml/System.Windows.Media.Animation/EasingByteKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingByteKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -186,19 +186,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingColorKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingColorKeyFrame.xml index 12380a9d63e..e2fdce5e2b5 100644 --- a/xml/System.Windows.Media.Animation/EasingColorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingColorKeyFrame.xml @@ -197,12 +197,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: diff --git a/xml/System.Windows.Media.Animation/EasingDecimalKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingDecimalKeyFrame.xml index 82d1f8378b9..37d53d0c700 100644 --- a/xml/System.Windows.Media.Animation/EasingDecimalKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingDecimalKeyFrame.xml @@ -23,13 +23,13 @@ An abstract class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -186,19 +186,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingDoubleKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingDoubleKeyFrame.xml index 1a97ec9635b..b55347475c6 100644 --- a/xml/System.Windows.Media.Animation/EasingDoubleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingDoubleKeyFrame.xml @@ -202,12 +202,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: diff --git a/xml/System.Windows.Media.Animation/EasingFunctionBase.xml b/xml/System.Windows.Media.Animation/EasingFunctionBase.xml index 5c64b5ba0f3..c3a0334f3d3 100644 --- a/xml/System.Windows.Media.Animation/EasingFunctionBase.xml +++ b/xml/System.Windows.Media.Animation/EasingFunctionBase.xml @@ -35,7 +35,7 @@ ## Examples - The following example demonstrates how to create a simple custom easing function. You can add your own mathematical logic for how the easing function behaves by overriding the method. + The following example demonstrates how to create a simple custom easing function. You can add your own mathematical logic for how the easing function behaves by overriding the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Animation/EasingFunctionBase/Overview/customlog10easingfunction.cs" id="Snippetcustomeasingfunction"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Animation/EasingFunctionBase/Overview/customlog10easingfunction.vb" id="Snippetcustomeasingfunction"::: @@ -113,7 +113,7 @@ property in conjunction with the method to evaluate the easing function. + Uses the property in conjunction with the method to evaluate the easing function. ]]> @@ -153,9 +153,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method handles transforming `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method handles transforming `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/EasingInt16KeyFrame.xml b/xml/System.Windows.Media.Animation/EasingInt16KeyFrame.xml index aa6d17eba74..4e55883f83b 100644 --- a/xml/System.Windows.Media.Animation/EasingInt16KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingInt16KeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -186,19 +186,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingInt32KeyFrame.xml b/xml/System.Windows.Media.Animation/EasingInt32KeyFrame.xml index 9c56ee6126d..b92d2acea8a 100644 --- a/xml/System.Windows.Media.Animation/EasingInt32KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingInt32KeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -186,19 +186,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingInt64KeyFrame.xml b/xml/System.Windows.Media.Animation/EasingInt64KeyFrame.xml index 5438ea2e45e..5d6f2f37436 100644 --- a/xml/System.Windows.Media.Animation/EasingInt64KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingInt64KeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of an in conjunction with an to animate an property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -185,19 +185,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingMode.xml b/xml/System.Windows.Media.Animation/EasingMode.xml index 4795c8fe18b..b768122fd1c 100644 --- a/xml/System.Windows.Media.Animation/EasingMode.xml +++ b/xml/System.Windows.Media.Animation/EasingMode.xml @@ -25,7 +25,7 @@ , where *f*(*t*) represents the animation progress and *t* represents time. + The following graphs demonstrate the different values of , where *f*(*t*) represents the animation progress and *t* represents time. diff --git a/xml/System.Windows.Media.Animation/EasingPoint3DKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingPoint3DKeyFrame.xml index 51a79b0acfd..fd02992a84c 100644 --- a/xml/System.Windows.Media.Animation/EasingPoint3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingPoint3DKeyFrame.xml @@ -23,11 +23,11 @@ A class that enables you to associate easing functions with a key frame animation. - in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -193,19 +193,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingPointKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingPointKeyFrame.xml index 4361bbe9be7..738acd8285a 100644 --- a/xml/System.Windows.Media.Animation/EasingPointKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingPointKeyFrame.xml @@ -204,12 +204,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: diff --git a/xml/System.Windows.Media.Animation/EasingQuaternionKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingQuaternionKeyFrame.xml index c7d4f538012..8c87ef2d7e6 100644 --- a/xml/System.Windows.Media.Animation/EasingQuaternionKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingQuaternionKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -195,19 +195,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingRectKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingRectKeyFrame.xml index ddb1d68a4d5..a9ff61944d3 100644 --- a/xml/System.Windows.Media.Animation/EasingRectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingRectKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -194,19 +194,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingRotation3DKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingRotation3DKeyFrame.xml index 9100afbac11..3669f1285d4 100644 --- a/xml/System.Windows.Media.Animation/EasingRotation3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingRotation3DKeyFrame.xml @@ -23,11 +23,11 @@ A class that enables you to associate easing functions with a key frame animation. - in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -192,19 +192,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingSingleKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingSingleKeyFrame.xml index d1b10d3e90e..a52b0236287 100644 --- a/xml/System.Windows.Media.Animation/EasingSingleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingSingleKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -185,19 +185,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingSizeKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingSizeKeyFrame.xml index 944e5bbc568..01125302fb0 100644 --- a/xml/System.Windows.Media.Animation/EasingSizeKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingSizeKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -195,19 +195,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingThicknessKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingThicknessKeyFrame.xml index 12451cb92fa..bb9328c47a7 100644 --- a/xml/System.Windows.Media.Animation/EasingThicknessKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingThicknessKeyFrame.xml @@ -23,13 +23,13 @@ A class that enables you to associate easing functions with a key frame animation. - . - - This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + . + + This class is used as part of a in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -192,19 +192,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingVector3DKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingVector3DKeyFrame.xml index 81b1dc9257d..c2632b13ab4 100644 --- a/xml/System.Windows.Media.Animation/EasingVector3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingVector3DKeyFrame.xml @@ -23,11 +23,11 @@ A class that enables you to associate easing functions with a key frame animation. - in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -191,19 +191,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/EasingVectorKeyFrame.xml b/xml/System.Windows.Media.Animation/EasingVectorKeyFrame.xml index b9c5d5f34c8..63fc0176ac9 100644 --- a/xml/System.Windows.Media.Animation/EasingVectorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/EasingVectorKeyFrame.xml @@ -23,11 +23,11 @@ A class that enables you to associate easing functions with a key frame animation. - in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. - + in conjunction with a to animate a property value along a set of key frames. This interpolates between the value of the previous key frame and its own value linearly with an easing function to produce its output value. + ]]> @@ -193,19 +193,19 @@ Creates a new instance of the derived class. When creating a derived class, you must override this method. The new instance. - . Because of this, you need to override the method to construct a custom animation object. - - - -## Examples - The following example shows a typical implementation of . - + . Because of this, you need to override the method to construct a custom animation object. + + + +## Examples + The following example shows a typical implementation of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: + ]]> diff --git a/xml/System.Windows.Media.Animation/ElasticEase.xml b/xml/System.Windows.Media.Animation/ElasticEase.xml index 18dc654e224..ce3bd193e11 100644 --- a/xml/System.Windows.Media.Animation/ElasticEase.xml +++ b/xml/System.Windows.Media.Animation/ElasticEase.xml @@ -26,14 +26,14 @@ property value. The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control when in the "spring" behavior occurs in an animation by specifying the property value. The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![ElasticEase with graphs of different easingmodes.](~/add/media/elasticease-graph.png "ElasticEase with graphs of different easingmodes.") You can specify how many times the animation oscillates back and forth using the property and how tight the springiness of the oscillations are using the property. > [!NOTE] -> Because this animation causes values to oscillate back and forth, the animation might interpolate into negative numbers unexpectedly. This can cause errors when animating properties that do not allow negative numbers. For example, if you apply this animation to the of an object (e.g. from 0 to 200 with an of ), the animation will attempt to interpolate through negative numbers for which will throw an error. +> Because this animation causes values to oscillate back and forth, the animation might interpolate into negative numbers unexpectedly. This can cause errors when animating properties that do not allow negative numbers. For example, if you apply this animation to the of an object (e.g. from 0 to 200 with an of ), the animation will attempt to interpolate through negative numbers for which will throw an error. There are several other easing functions besides . In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -125,12 +125,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -172,9 +172,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> @@ -285,11 +285,11 @@ value is, the stiffer the spring and the faster the elasticity decreases in intensity over each oscillation. + The smaller the value is, the stiffer the spring and the faster the elasticity decreases in intensity over each oscillation. Dependency property identifier field: - The following diagram illustrates the effect of different values of . + The following diagram illustrates the effect of different values of . ![Demonstrates different Springiness values.](~/add/media/elasticease-springiness.png "Demonstrates different Springiness values.") diff --git a/xml/System.Windows.Media.Animation/ExponentialEase.xml b/xml/System.Windows.Media.Animation/ExponentialEase.xml index c1f69801acd..20776479c89 100644 --- a/xml/System.Windows.Media.Animation/ExponentialEase.xml +++ b/xml/System.Windows.Media.Animation/ExponentialEase.xml @@ -26,7 +26,7 @@ . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates or both by specifying the . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. ![ExponentialEase graphs of different easingmodes.](~/add/media/exponentialease-graph.png "ExponentialEase graphs of different easingmodes.") @@ -118,12 +118,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -165,9 +165,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/HandoffBehavior.xml b/xml/System.Windows.Media.Animation/HandoffBehavior.xml index 482402debb0..f6a0f421034 100644 --- a/xml/System.Windows.Media.Animation/HandoffBehavior.xml +++ b/xml/System.Windows.Media.Animation/HandoffBehavior.xml @@ -30,9 +30,9 @@ To avoid performance issues when you apply a large number of clocks using Compose, you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This will remove all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event will not be raised if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event will not be raised if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks will also be disconnected and garbage collected. diff --git a/xml/System.Windows.Media.Animation/IAnimatable.xml b/xml/System.Windows.Media.Animation/IAnimatable.xml index 7478e1a7162..cd9763ffba2 100644 --- a/xml/System.Windows.Media.Animation/IAnimatable.xml +++ b/xml/System.Windows.Media.Animation/IAnimatable.xml @@ -118,11 +118,11 @@ Initiates an animation sequence for this instance. - @@ -159,11 +159,11 @@ The timeline with the necessary functionality to animate the property. Initiates an animation sequence for the object, based on the specified . - @@ -202,11 +202,11 @@ The object specifying the manner in which to interact with all relevant animation sequences. Initiates an animation sequence for the .object, based on both the specified and . - @@ -242,11 +242,11 @@ Retrieves the base value of the specified object. The object representing the base value of . - when you want to retrieve the non-animated value of an animated property. This method takes advantage of the fact that Windows Presentation Foundation (WPF) animations do not remove the target property's original value. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - + when you want to retrieve the non-animated value of an animated property. This method takes advantage of the fact that Windows Presentation Foundation (WPF) animations do not remove the target property's original value. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + ]]> @@ -280,11 +280,11 @@ if a is associated with at least one of the current object's properties; otherwise . - or . - + or . + ]]> diff --git a/xml/System.Windows.Media.Animation/Int16Animation.xml b/xml/System.Windows.Media.Animation/Int16Animation.xml index 9872b28813d..2807b6f2bb7 100644 --- a/xml/System.Windows.Media.Animation/Int16Animation.xml +++ b/xml/System.Windows.Media.Animation/Int16Animation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -356,7 +356,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -487,17 +487,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -589,7 +589,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -629,7 +629,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -677,7 +677,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -726,17 +726,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Int16AnimationBase.xml b/xml/System.Windows.Media.Animation/Int16AnimationBase.xml index d18db5703cd..22c73aeaac5 100644 --- a/xml/System.Windows.Media.Animation/Int16AnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Int16AnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . @@ -167,7 +167,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -225,7 +225,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -283,7 +283,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/Int16AnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Int16AnimationUsingKeyFrames.xml index 50a9d814850..fc81436d508 100644 --- a/xml/System.Windows.Media.Animation/Int16AnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Int16AnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Int16KeyFrame.xml b/xml/System.Windows.Media.Animation/Int16KeyFrame.xml index 022ea74e644..ff62d3f366f 100644 --- a/xml/System.Windows.Media.Animation/Int16KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Int16KeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Int16KeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Int16KeyFrameCollection.xml index 46badeff31e..47c1a0fa6d9 100644 --- a/xml/System.Windows.Media.Animation/Int16KeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Int16KeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -165,13 +165,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -206,13 +206,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -247,13 +247,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -291,13 +291,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -494,15 +494,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -537,13 +537,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -579,21 +579,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -629,15 +629,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -774,11 +774,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -816,10 +816,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/Int32Animation.xml b/xml/System.Windows.Media.Animation/Int32Animation.xml index 4a1980c6a67..9715f902ad4 100644 --- a/xml/System.Windows.Media.Animation/Int32Animation.xml +++ b/xml/System.Windows.Media.Animation/Int32Animation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -356,7 +356,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -487,17 +487,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -589,7 +589,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -629,7 +629,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -677,7 +677,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -725,17 +725,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Int32AnimationBase.xml b/xml/System.Windows.Media.Animation/Int32AnimationBase.xml index f6b300d6a44..f20e9be2946 100644 --- a/xml/System.Windows.Media.Animation/Int32AnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Int32AnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/Int32AnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Int32AnimationUsingKeyFrames.xml index 10feec6ae73..df5cefbca82 100644 --- a/xml/System.Windows.Media.Animation/Int32AnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Int32AnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Int32KeyFrame.xml b/xml/System.Windows.Media.Animation/Int32KeyFrame.xml index a76fca07833..f1318ae7556 100644 --- a/xml/System.Windows.Media.Animation/Int32KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Int32KeyFrame.xml @@ -178,7 +178,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Int32KeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Int32KeyFrameCollection.xml index 0250410d294..8a6b2d8d733 100644 --- a/xml/System.Windows.Media.Animation/Int32KeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Int32KeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -165,13 +165,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -206,13 +206,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -247,13 +247,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -291,13 +291,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -494,15 +494,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -537,13 +537,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -579,21 +579,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -629,15 +629,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -774,11 +774,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -816,10 +816,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/Int64Animation.xml b/xml/System.Windows.Media.Animation/Int64Animation.xml index 156fdd76add..22b4d7797af 100644 --- a/xml/System.Windows.Media.Animation/Int64Animation.xml +++ b/xml/System.Windows.Media.Animation/Int64Animation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -356,7 +356,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -486,17 +486,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -618,7 +618,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -666,7 +666,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -714,17 +714,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Int64AnimationBase.xml b/xml/System.Windows.Media.Animation/Int64AnimationBase.xml index c82103e6232..b4da60dea7a 100644 --- a/xml/System.Windows.Media.Animation/Int64AnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Int64AnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/Int64AnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Int64AnimationUsingKeyFrames.xml index 58331867df7..472f0be503a 100644 --- a/xml/System.Windows.Media.Animation/Int64AnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Int64AnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Int64KeyFrame.xml b/xml/System.Windows.Media.Animation/Int64KeyFrame.xml index 32c65c78158..5427cbbcb18 100644 --- a/xml/System.Windows.Media.Animation/Int64KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Int64KeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Int64KeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Int64KeyFrameCollection.xml index 3842605445c..b657033000d 100644 --- a/xml/System.Windows.Media.Animation/Int64KeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Int64KeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -165,13 +165,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -206,13 +206,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -247,13 +247,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -291,13 +291,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -494,15 +494,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -537,13 +537,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -579,21 +579,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -629,15 +629,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -774,11 +774,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -816,10 +816,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/KeySpline.xml b/xml/System.Windows.Media.Animation/KeySpline.xml index c2fed6cb905..5b339c36429 100644 --- a/xml/System.Windows.Media.Animation/KeySpline.xml +++ b/xml/System.Windows.Media.Animation/KeySpline.xml @@ -53,16 +53,16 @@ ## XAML Values *cp1X* - component of the curve's first control point. The value must be between 0 and 1. + component of the curve's first control point. The value must be between 0 and 1. *cp1Y* - component of the curve's first control point. The value must be between 0 and 1. + component of the curve's first control point. The value must be between 0 and 1. *cp2X* - component of the curve's second control point. The value must be between 0 and 1. + component of the curve's second control point. The value must be between 0 and 1. *cp2Y* - component of the curve's second control point. The value must be between 0 and 1. + component of the curve's second control point. The value must be between 0 and 1. The separator between values may be either comma or one or more spaces. The convention shown here of commas between components of a point and space between points is a recommended convention. Do not use a comma as the decimal point within the values of point components, even if that is the norm in your culture. XAML values are treated as en-us in all type conversion cases, and the comma is thus interpreted as the separator and not as the intended decimal point. @@ -106,7 +106,7 @@ and are (0,0) and (1,1) respectively, which has no effect on the progress of an animation or key frame. + The default values for and are (0,0) and (1,1) respectively, which has no effect on the progress of an animation or key frame. ]]> @@ -211,9 +211,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -252,9 +252,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -397,11 +397,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -440,9 +440,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Animation/KeyTime.xml b/xml/System.Windows.Media.Animation/KeyTime.xml index 9c704df14e9..ef2af3ab805 100644 --- a/xml/System.Windows.Media.Animation/KeyTime.xml +++ b/xml/System.Windows.Media.Animation/KeyTime.xml @@ -39,7 +39,7 @@ ## Remarks Each key frame's specifies when that key frame ends. It does not specify how long the key time plays. The amount of time a key frame plays is determined by when the key frame ends, when the previous key frame ended, and the animation's duration. See [Key-Frame Animations Overview](/dotnet/framework/wpf/graphics-multimedia/key-frame-animations-overview) for more information. - A may be expressed in several different formats, including a numeric time value, as a percentage, or as one of the special sentinel values or . + A may be expressed in several different formats, including a numeric time value, as a percentage, or as one of the special sentinel values or . ## XAML Attribute Usage @@ -55,11 +55,11 @@ -or- - \<*object* *property*=""/> + \<*object* *property*=""/> -or- - \<*object* *property*=""/> + \<*object* *property*=""/> ## XAML Values @@ -474,7 +474,7 @@ , available time is allocated according to the length of each of the key frames to determine the duration of each frame. This will provide the behavior that the "velocity" or pace of the animation will remain constant. + When a key time is set to , available time is allocated according to the length of each of the key frames to determine the duration of each frame. This will provide the behavior that the "velocity" or pace of the animation will remain constant. ]]> @@ -649,7 +649,7 @@ , the total allotted time of the animation is divided evenly between key frames. For example, if the key frame animation has a duration of four seconds and there are four key frames, each key frame will last for one second and begin immediately after the preceding one ends. + When a key time is set to , the total allotted time of the animation is divided evenly between key frames. For example, if the key frame animation has a duration of four seconds and there are four key frames, each key frame will last for one second and begin immediately after the preceding one ends. ]]> diff --git a/xml/System.Windows.Media.Animation/LinearByteKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearByteKeyFrame.xml index 131b08ab8d3..74bb24fd87d 100644 --- a/xml/System.Windows.Media.Animation/LinearByteKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearByteKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearColorKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearColorKeyFrame.xml index 02eb3565c24..57e177882ee 100644 --- a/xml/System.Windows.Media.Animation/LinearColorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearColorKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearDecimalKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearDecimalKeyFrame.xml index 33dd2b4aba8..a81880a251e 100644 --- a/xml/System.Windows.Media.Animation/LinearDecimalKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearDecimalKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearDoubleKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearDoubleKeyFrame.xml index 9a8a963300f..744d4b0cb98 100644 --- a/xml/System.Windows.Media.Animation/LinearDoubleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearDoubleKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearInt16KeyFrame.xml b/xml/System.Windows.Media.Animation/LinearInt16KeyFrame.xml index bce3170c228..30505805535 100644 --- a/xml/System.Windows.Media.Animation/LinearInt16KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearInt16KeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearInt32KeyFrame.xml b/xml/System.Windows.Media.Animation/LinearInt32KeyFrame.xml index 8bc049806eb..abcffd54dba 100644 --- a/xml/System.Windows.Media.Animation/LinearInt32KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearInt32KeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearInt64KeyFrame.xml b/xml/System.Windows.Media.Animation/LinearInt64KeyFrame.xml index 6785a6463f6..4fe7fca03dc 100644 --- a/xml/System.Windows.Media.Animation/LinearInt64KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearInt64KeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearPoint3DKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearPoint3DKeyFrame.xml index 8aee1f739e6..f258abd594f 100644 --- a/xml/System.Windows.Media.Animation/LinearPoint3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearPoint3DKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearPointKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearPointKeyFrame.xml index 878d596b7ac..bb7eeffbc02 100644 --- a/xml/System.Windows.Media.Animation/LinearPointKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearPointKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearQuaternionKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearQuaternionKeyFrame.xml index 6b0f52b2d64..8bffb730b7c 100644 --- a/xml/System.Windows.Media.Animation/LinearQuaternionKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearQuaternionKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. ]]> diff --git a/xml/System.Windows.Media.Animation/LinearRectKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearRectKeyFrame.xml index abbb3b69ec3..a34aaa0ca1e 100644 --- a/xml/System.Windows.Media.Animation/LinearRectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearRectKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearRotation3DKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearRotation3DKeyFrame.xml index e3fd036a26b..49f63f8f0ac 100644 --- a/xml/System.Windows.Media.Animation/LinearRotation3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearRotation3DKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a object to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a object to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearSingleKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearSingleKeyFrame.xml index eba54527c9c..ab24cbd1b18 100644 --- a/xml/System.Windows.Media.Animation/LinearSingleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearSingleKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearSizeKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearSizeKeyFrame.xml index 5af5e5b0f18..5b09412dd3c 100644 --- a/xml/System.Windows.Media.Animation/LinearSizeKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearSizeKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearThicknessKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearThicknessKeyFrame.xml index c3198a997e5..db5731b696e 100644 --- a/xml/System.Windows.Media.Animation/LinearThicknessKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearThicknessKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearVector3DKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearVector3DKeyFrame.xml index 9db969efd85..12d30c818fd 100644 --- a/xml/System.Windows.Media.Animation/LinearVector3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearVector3DKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/LinearVectorKeyFrame.xml b/xml/System.Windows.Media.Animation/LinearVectorKeyFrame.xml index e12ccda955b..3de721992a8 100644 --- a/xml/System.Windows.Media.Animation/LinearVectorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/LinearVectorKeyFrame.xml @@ -24,15 +24,15 @@ Animates from the value of the previous key frame to its own using linear interpolation. - in conjunction with a to animate a property value along a set of key frames. - - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. - - Linear key frames like create a smooth, linear interpolation between values. - + in conjunction with a to animate a property value along a set of key frames. + + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + + Linear key frames like create a smooth, linear interpolation between values. + ]]> diff --git a/xml/System.Windows.Media.Animation/MatrixAnimationBase.xml b/xml/System.Windows.Media.Animation/MatrixAnimationBase.xml index 5c0ea14bb3e..a9bd3839d30 100644 --- a/xml/System.Windows.Media.Animation/MatrixAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/MatrixAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/MatrixAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/MatrixAnimationUsingKeyFrames.xml index a6368fcb502..b3c83aea3ed 100644 --- a/xml/System.Windows.Media.Animation/MatrixAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/MatrixAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ]]> @@ -198,7 +198,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -237,9 +237,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -278,7 +278,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -317,9 +317,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -425,11 +425,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -468,9 +468,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -514,7 +514,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/MatrixAnimationUsingPath.xml b/xml/System.Windows.Media.Animation/MatrixAnimationUsingPath.xml index 629d63f4466..ef85fda191a 100644 --- a/xml/System.Windows.Media.Animation/MatrixAnimationUsingPath.xml +++ b/xml/System.Windows.Media.Animation/MatrixAnimationUsingPath.xml @@ -29,7 +29,7 @@ ## Remarks enables you to animate the angle and position of an object with a single animation and . - A animates its target by using linear interpolation over the specified . + A animates its target by using linear interpolation over the specified . ]]> @@ -104,7 +104,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -252,7 +252,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -307,7 +307,7 @@ ## Examples - The following example uses two similar animations to animate the same rectangle. The first animation's property is set to `false`, so it always animates the rectangle from (0,0), the animation's starting value. The second animation has the same target values (their settings are identical), but its property is set to `true`; as a result, it animates the rectangle from whatever position it is at when the animation is applied. + The following example uses two similar animations to animate the same rectangle. The first animation's property is set to `false`, so it always animates the rectangle from (0,0), the animation's starting value. The second animation has the same target values (their settings are identical), but its property is set to `true`; as a result, it animates the rectangle from whatever position it is at when the animation is applied. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/DoubleAnimationUsingPath/PathGeometry/matrixanimationusingpathisadditiveexample.xaml" id="Snippetmatrixanimationusingpathisadditiveexamplewholepage"::: @@ -346,11 +346,11 @@ of `true`, your object might appear to tumble while it bounces (depending on the path you specify). For related information, see . + If this property is set to `true`, the rotation angle of the animated matrix will accumulate as the animation repeats. If your path is a small arc, a cumulative angle will cause your object to continuously rotate with each repeat instead of restarting the rotation. When combined with an of `true`, your object might appear to tumble while it bounces (depending on the path you specify). For related information, see . - Setting this property has no effect if is `false`. + Setting this property has no effect if is `false`. - This property determines whether the animation matrix's angle accumulates when the animation repeats because of its setting; it does not cause the offset to accumulate when the animation is restarted. For information on how to make an animation build off a previous animation's values, see . + This property determines whether the animation matrix's angle accumulates when the animation repeats because of its setting; it does not cause the offset to accumulate when the animation is restarted. For information on how to make an animation build off a previous animation's values, see . ## Dependency Property Information @@ -363,7 +363,7 @@ ## Examples - The following example uses two similar animations to animate the same rectangle. Both animations have the same setting, which causes the rectangle to rotate as it moves along the screen to the right, and both animations are set to repeat four times. The first animation's property is set to `false`, so the rectangle jumps back to its original angle when the animation repeats. The second animation's property is set to `true`; as a result, the rectangle angle appears to increase when the animation repeats, rather than jumping back to its original value. + The following example uses two similar animations to animate the same rectangle. Both animations have the same setting, which causes the rectangle to rotate as it moves along the screen to the right, and both animations are set to repeat four times. The first animation's property is set to `false`, so the rectangle jumps back to its original angle when the animation repeats. The second animation's property is set to `true`; as a result, the rectangle angle appears to increase when the animation repeats, rather than jumping back to its original value. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/DoubleAnimationUsingPath/PathGeometry/matrixanimationusingpathisanglecumulativeexample.xaml" id="Snippetmatrixanimationusingpathisanglecumulativeexamplewholepage"::: @@ -434,7 +434,7 @@ ## Remarks If this property is set to `true`, the offset of the animated matrix will accumulate as the animation repeats. For example, if the path is a small arc and the animation is set to repeat, a cumulative offset will cause the object to appear to bounce across the screen. - This property determines whether the animation matrix's offset accumulates when the animation repeats because of its setting; it does not cause the offset to accumulate when the animation is restarted. For information on how to make an animation build off a previous animation's values, see . + This property determines whether the animation matrix's offset accumulates when the animation repeats because of its setting; it does not cause the offset to accumulate when the animation is restarted. For information on how to make an animation build off a previous animation's values, see . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/MatrixKeyFrame.xml b/xml/System.Windows.Media.Animation/MatrixKeyFrame.xml index d6f37ab31ed..d42481e5dc4 100644 --- a/xml/System.Windows.Media.Animation/MatrixKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/MatrixKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/MatrixKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/MatrixKeyFrameCollection.xml index 8ff20504c6a..5327751bc58 100644 --- a/xml/System.Windows.Media.Animation/MatrixKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/MatrixKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreMatrixKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreMatrixKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreMatrixKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreMatrixKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/ObjectAnimationBase.xml b/xml/System.Windows.Media.Animation/ObjectAnimationBase.xml index 4243ed70a77..196c25ce5a2 100644 --- a/xml/System.Windows.Media.Animation/ObjectAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/ObjectAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/ObjectAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/ObjectAnimationUsingKeyFrames.xml index 29e03993332..09537473347 100644 --- a/xml/System.Windows.Media.Animation/ObjectAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/ObjectAnimationUsingKeyFrames.xml @@ -41,10 +41,10 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ## Animating the Key Frames of an ObjectAnimationUsingKeyFrames - You can't animate an object that is the output of another animation. For example, if you use an to animate the of a from a to a , you can't animate any properties of the or . + You can't animate an object that is the output of another animation. For example, if you use an to animate the of a from a to a , you can't animate any properties of the or . ]]> @@ -201,7 +201,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -240,9 +240,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -281,7 +281,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -320,9 +320,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -428,11 +428,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -471,9 +471,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -517,7 +517,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/ObjectKeyFrame.xml b/xml/System.Windows.Media.Animation/ObjectKeyFrame.xml index 7f53349e5b2..61506eb2758 100644 --- a/xml/System.Windows.Media.Animation/ObjectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/ObjectKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/ObjectKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/ObjectKeyFrameCollection.xml index dacfa91bdfb..498f8c918c3 100644 --- a/xml/System.Windows.Media.Animation/ObjectKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/ObjectKeyFrameCollection.xml @@ -187,7 +187,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -226,9 +226,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -267,9 +267,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -311,7 +311,7 @@ . That is, this method is an O(*n*) operation, where *n* is . + This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(*n*) operation, where *n* is . This method determines equality by calling the object's Equals method. @@ -512,11 +512,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -555,9 +555,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -599,13 +599,13 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + Initially, the enumerator is positioned before the first item in the collection. also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - returns the same object until either or is called. sets to the next item. + returns the same object until either or is called. sets to the next item. - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. @@ -649,9 +649,9 @@ ## Remarks The collection is searched forward starting at the first key frame and ending at the last key frame. - This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(*n*) operation, where *n* is . + This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(*n*) operation, where *n* is . - This method determines equality by calling . + This method determines equality by calling . ]]> diff --git a/xml/System.Windows.Media.Animation/ParallelTimeline.xml b/xml/System.Windows.Media.Animation/ParallelTimeline.xml index beed1de9928..0da3608dd70 100644 --- a/xml/System.Windows.Media.Animation/ParallelTimeline.xml +++ b/xml/System.Windows.Media.Animation/ParallelTimeline.xml @@ -29,7 +29,7 @@ ## Remarks objects can be children (nested inside) of a . This can provide better encapsulation of timing sequences in complex animations. - has its own property therefore all child timeline values are relative to the parent value for . + has its own property therefore all child timeline values are relative to the parent value for . ]]> @@ -219,7 +219,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -258,7 +258,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -295,7 +295,7 @@ method. + This method overrides the method. ]]> @@ -335,7 +335,7 @@ it means that the natural duration is unknown. In this case, the of the is determined by the author. For example, the duration of streaming media would be determined by the provider of the streaming media. + A natural duration is the period of a single iteration. If this method returns it means that the natural duration is unknown. In this case, the of the is determined by the author. For example, the duration of streaming media would be determined by the provider of the streaming media. ]]> @@ -379,21 +379,21 @@ ## Remarks It is often desirable to synchronize animations and media. However, this is complicated by the fact that media playback can be delayed by loading or buffering making it difficult to reliably play an animation along with media. The property is used to determine what happens when media and animations are played together. A value of (default) specifies that animation timelines do not need to be synced and will play when specified regardless of the state of other media in the timeline. A value of on the other hand, specifies that an animation will wait (slip) until media is ready to play. The diagrams below illustrate this behavior. - This plays a video and an animation. When is set to and the property of the is set to , the grows to play all media and animations. + This plays a video and an animation. When is set to and the property of the is set to , the grows to play all media and animations. ![Diagram: Key for SlipBehavior diagram](~/add/media/slipbehaviorkey.png "Diagram: Key for SlipBehavior diagram") ![Diagram: SlipBehavior property value of Grow](~/add/media/slipbehaviorgrow1.png "Diagram: SlipBehavior property value of Grow") - This has a of and a of 5 seconds which gives media and animations 5 seconds to play regardless of how much they slip. + This has a of and a of 5 seconds which gives media and animations 5 seconds to play regardless of how much they slip. ![Diagram: SlipBehavior property value of Grow](~/add/media/slipbehaviorgrow2.png "Diagram: SlipBehavior property value of Grow") - This has a of . Note that the (and any other non-media children of the ) does not progress unless the media timeline is also progressing. If the media takes a while to load, or if it is buffering, the animation will wait (slips) with it. This allows animations to synchronize with a single media file. + This has a of . Note that the (and any other non-media children of the ) does not progress unless the media timeline is also progressing. If the media takes a while to load, or if it is buffering, the animation will wait (slips) with it. This allows animations to synchronize with a single media file. ![SlipBehavior diagram for media and animation](~/add/media/slipbehaviorslip1.png "SlipBehavior diagram for media and animation") - This has a of and a of 5 seconds. In this scenario, the media file and animation are guaranteed to play for 5 seconds. + This has a of and a of 5 seconds. In this scenario, the media file and animation are guaranteed to play for 5 seconds. ![Diagram: SlipBehavior property of a Storyboard](~/add/media/slipbehaviorslip2.png "Diagram: SlipBehavior property of a Storyboard") @@ -439,7 +439,7 @@ dependency property. + The identifier for the dependency property. diff --git a/xml/System.Windows.Media.Animation/PathAnimationSource.xml b/xml/System.Windows.Media.Animation/PathAnimationSource.xml index 7e829854dc9..51304c3ab20 100644 --- a/xml/System.Windows.Media.Animation/PathAnimationSource.xml +++ b/xml/System.Windows.Media.Animation/PathAnimationSource.xml @@ -26,7 +26,7 @@ ) using a of `Y`, then the animation will animate the x-coordinate of the object using the y-coordinates of the path. + There are three possible output property values that a path animation can move along: `X`, `Y`, and `Angle`. By specifying one of these values, you're telling the animation to use that property output value of the path to drive the animation. For example, if you're animating the property that specifies the x-coordinate of an object (that is, ) using a of `Y`, then the animation will animate the x-coordinate of the object using the y-coordinates of the path. ]]> diff --git a/xml/System.Windows.Media.Animation/PauseStoryboard.xml b/xml/System.Windows.Media.Animation/PauseStoryboard.xml index d77ac0fae67..729f42b73b1 100644 --- a/xml/System.Windows.Media.Animation/PauseStoryboard.xml +++ b/xml/System.Windows.Media.Animation/PauseStoryboard.xml @@ -24,18 +24,18 @@ A trigger action that pauses a . - with an or a to pause a Storyboard. - - only affects a when it is active (after the starts). - - To control a , the must reference the of the that controls that . See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for an example. - -## Beginning a Paused Animation - When a action is triggered after it has been paused, it appears to resume and restart. That's not what actually happens, however: the action actually replaces itself with an unpaused version. Each time a action is triggered, clock objects are created for its storyboard. These clocks are distributed to the properties they animate. So, when a is triggered again, it doesn't restart its clocks, it replaces them with new clocks. - + with an or a to pause a Storyboard. + + only affects a when it is active (after the starts). + + To control a , the must reference the of the that controls that . See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for an example. + +## Beginning a Paused Animation + When a action is triggered after it has been paused, it appears to resume and restart. That's not what actually happens, however: the action actually replaces itself with an unpaused version. Each time a action is triggered, clock objects are created for its storyboard. These clocks are distributed to the properties they animate. So, when a is triggered again, it doesn't restart its clocks, it replaces them with new clocks. + ]]> diff --git a/xml/System.Windows.Media.Animation/Point3DAnimation.xml b/xml/System.Windows.Media.Animation/Point3DAnimation.xml index fdcf11b6173..9d283214e52 100644 --- a/xml/System.Windows.Media.Animation/Point3DAnimation.xml +++ b/xml/System.Windows.Media.Animation/Point3DAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -258,17 +258,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -367,7 +367,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -498,17 +498,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -612,7 +612,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -651,7 +651,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -699,7 +699,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -747,17 +747,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Point3DAnimationBase.xml b/xml/System.Windows.Media.Animation/Point3DAnimationBase.xml index c9d1136ad36..6980dcd2369 100644 --- a/xml/System.Windows.Media.Animation/Point3DAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Point3DAnimationBase.xml @@ -93,7 +93,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -152,7 +152,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -210,7 +210,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -268,7 +268,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/Point3DAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Point3DAnimationUsingKeyFrames.xml index 14707f95367..6107a492abf 100644 --- a/xml/System.Windows.Media.Animation/Point3DAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Point3DAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Point3DKeyFrame.xml b/xml/System.Windows.Media.Animation/Point3DKeyFrame.xml index d8de7590116..e3497873fc1 100644 --- a/xml/System.Windows.Media.Animation/Point3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Point3DKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Point3DKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Point3DKeyFrameCollection.xml index 4ab9dd9a7f5..803975cf5b2 100644 --- a/xml/System.Windows.Media.Animation/Point3DKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Point3DKeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -162,13 +162,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -203,13 +203,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -244,13 +244,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -288,13 +288,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -490,15 +490,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -533,13 +533,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -575,21 +575,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -625,15 +625,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -770,11 +770,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -812,10 +812,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/PointAnimation.xml b/xml/System.Windows.Media.Animation/PointAnimation.xml index ca99ffced8a..0aa67c01663 100644 --- a/xml/System.Windows.Media.Animation/PointAnimation.xml +++ b/xml/System.Windows.Media.Animation/PointAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you must associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -368,7 +368,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -499,17 +499,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -613,7 +613,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -653,7 +653,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -701,7 +701,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -749,17 +749,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/PointAnimationBase.xml b/xml/System.Windows.Media.Animation/PointAnimationBase.xml index cc83389e0b8..6d7aaf732d5 100644 --- a/xml/System.Windows.Media.Animation/PointAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/PointAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/PointAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/PointAnimationUsingKeyFrames.xml index d635e452318..e7341e2c77c 100644 --- a/xml/System.Windows.Media.Animation/PointAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/PointAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/PointAnimationUsingPath.xml b/xml/System.Windows.Media.Animation/PointAnimationUsingPath.xml index e1d18dc2a5e..b09de9afcc7 100644 --- a/xml/System.Windows.Media.Animation/PointAnimationUsingPath.xml +++ b/xml/System.Windows.Media.Animation/PointAnimationUsingPath.xml @@ -27,7 +27,7 @@ uses linear interpolation over a specified . + uses linear interpolation over a specified . is particularly well suited for animating the position of an object on the screen if the object uses a property to specify position. @@ -105,7 +105,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -180,7 +180,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -267,7 +267,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/PointKeyFrame.xml b/xml/System.Windows.Media.Animation/PointKeyFrame.xml index 67200f24f6c..9497f3d45e3 100644 --- a/xml/System.Windows.Media.Animation/PointKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/PointKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/PointKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/PointKeyFrameCollection.xml index 530f879fc54..029772027bc 100644 --- a/xml/System.Windows.Media.Animation/PointKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/PointKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMorePointKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMorePointKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMorePointKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMorePointKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/PowerEase.xml b/xml/System.Windows.Media.Animation/PowerEase.xml index 89b9c4ac0cd..74476e6a4b3 100644 --- a/xml/System.Windows.Media.Animation/PowerEase.xml +++ b/xml/System.Windows.Media.Animation/PowerEase.xml @@ -26,7 +26,7 @@ . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates, or both by specifying the . The following graph demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![CubicEase EasingMode graphs.](~/add/media/cubicease-graph.png "CubicEase EasingMode graphs.") @@ -48,7 +48,7 @@ ## Examples - The following example applies a easing function with a property value of `20` to a to create a decelerating animation. Because the value is so high, the deceleration is sudden compared to if you used a lower value. + The following example applies a easing function with a property value of `20` to a to create a decelerating animation. Because the value is so high, the deceleration is sudden compared to if you used a lower value. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/PowerEase/Overview/window1.xaml" id="Snippetpowerease"::: @@ -126,12 +126,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -173,9 +173,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> @@ -222,7 +222,7 @@ ## Examples - The following example applies a easing function with a property value of `20` to a to create a decelerating animation. Because the value is so high, the deceleration is sudden compared to if you used a lower value. + The following example applies a easing function with a property value of `20` to a to create a decelerating animation. Because the value is so high, the deceleration is sudden compared to if you used a lower value. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/PowerEase/Overview/window1.xaml" id="Snippetpowerease"::: diff --git a/xml/System.Windows.Media.Animation/QuadraticEase.xml b/xml/System.Windows.Media.Animation/QuadraticEase.xml index 1c85e12c9b4..45d86007c2b 100644 --- a/xml/System.Windows.Media.Animation/QuadraticEase.xml +++ b/xml/System.Windows.Media.Animation/QuadraticEase.xml @@ -26,7 +26,7 @@ . The following graph below demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates, or both by specifying the . The following graph below demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![QuadraticEase with graphs of different easingmodes](~/add/media/quadraticease-graph.png "QuadraticEase with graphs of different easingmodes") @@ -35,7 +35,7 @@ *f*(*t*) = *t*2 > [!NOTE] -> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. +> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. There are several other easing functions besides . In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -117,12 +117,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -164,9 +164,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/QuarticEase.xml b/xml/System.Windows.Media.Animation/QuarticEase.xml index 5a3a8d8e062..d5b2351c84f 100644 --- a/xml/System.Windows.Media.Animation/QuarticEase.xml +++ b/xml/System.Windows.Media.Animation/QuarticEase.xml @@ -26,7 +26,7 @@ . The following graph below demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates, or both by specifying the . The following graph below demonstrates the different values of , where *f*(*t*) represents the animation progress and *t* represents time. ![QuarticEase with graphs of different easingmodes.](~/add/media/quarticease-graph.png "QuarticEase with graphs of different easingmodes.") @@ -35,7 +35,7 @@ *f*(*t*) = *t*4 > [!NOTE] -> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. +> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. There are several other easing functions besides . In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -127,12 +127,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -174,9 +174,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/QuaternionAnimation.xml b/xml/System.Windows.Media.Animation/QuaternionAnimation.xml index 1875a9dc930..a53dbafac07 100644 --- a/xml/System.Windows.Media.Animation/QuaternionAnimation.xml +++ b/xml/System.Windows.Media.Animation/QuaternionAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -272,17 +272,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -379,7 +379,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -510,17 +510,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -622,7 +622,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -661,7 +661,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -709,7 +709,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -756,17 +756,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/QuaternionAnimationBase.xml b/xml/System.Windows.Media.Animation/QuaternionAnimationBase.xml index 2b45e851329..e898fa76c09 100644 --- a/xml/System.Windows.Media.Animation/QuaternionAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/QuaternionAnimationBase.xml @@ -93,7 +93,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -152,7 +152,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -210,7 +210,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -268,7 +268,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/QuaternionAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/QuaternionAnimationUsingKeyFrames.xml index e7acbbed1fd..1f27aad1ee7 100644 --- a/xml/System.Windows.Media.Animation/QuaternionAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/QuaternionAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -205,7 +205,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -244,9 +244,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -285,7 +285,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -324,11 +324,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -433,11 +433,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -476,9 +476,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -522,7 +522,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -627,7 +627,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/QuaternionKeyFrame.xml b/xml/System.Windows.Media.Animation/QuaternionKeyFrame.xml index 7741701ede6..a40f8868c67 100644 --- a/xml/System.Windows.Media.Animation/QuaternionKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/QuaternionKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/QuaternionKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/QuaternionKeyFrameCollection.xml index b4ca393b326..2912520444f 100644 --- a/xml/System.Windows.Media.Animation/QuaternionKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/QuaternionKeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -165,13 +165,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -206,13 +206,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -247,13 +247,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -291,13 +291,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -494,15 +494,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -537,13 +537,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -579,21 +579,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -629,15 +629,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -774,11 +774,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -816,10 +816,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/QuinticEase.xml b/xml/System.Windows.Media.Animation/QuinticEase.xml index bc0aac9f38f..08cf342d404 100644 --- a/xml/System.Windows.Media.Animation/QuinticEase.xml +++ b/xml/System.Windows.Media.Animation/QuinticEase.xml @@ -26,7 +26,7 @@ . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. + You can control whether the animation accelerates, decelerates or both by specifying the . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. ![QuinticEase with graphs of different easingmodes.](~/add/media/quinticease-graph.png "QuinticEase with graphs of different easingmodes.") @@ -35,7 +35,7 @@ *f*(*t*) = *t*5 > [!NOTE] -> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. +> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. There are several other easing functions besides . In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -127,12 +127,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -174,9 +174,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/RectAnimation.xml b/xml/System.Windows.Media.Animation/RectAnimation.xml index 5f9eebc835e..47da3a57dc5 100644 --- a/xml/System.Windows.Media.Animation/RectAnimation.xml +++ b/xml/System.Windows.Media.Animation/RectAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,18 +259,18 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -369,7 +369,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. @@ -502,18 +502,18 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -617,7 +617,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -657,7 +657,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -705,7 +705,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -753,18 +753,18 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/RectAnimationBase.xml b/xml/System.Windows.Media.Animation/RectAnimationBase.xml index d8a02cbfbd9..a1e84ae8513 100644 --- a/xml/System.Windows.Media.Animation/RectAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/RectAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/RectAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/RectAnimationUsingKeyFrames.xml index 7816f38e0b2..84bd76c051e 100644 --- a/xml/System.Windows.Media.Animation/RectAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/RectAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -195,7 +195,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -234,9 +234,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -275,7 +275,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -314,9 +314,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -424,11 +424,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. If these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -467,9 +467,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -619,7 +619,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts, because its parent repeated, or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values accumulate only when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts, because its parent repeated, or because its clock was restarted from a call. ]]> @@ -656,7 +656,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ]]> diff --git a/xml/System.Windows.Media.Animation/RectKeyFrame.xml b/xml/System.Windows.Media.Animation/RectKeyFrame.xml index 2e116c971dd..79de4a21326 100644 --- a/xml/System.Windows.Media.Animation/RectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/RectKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/RectKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/RectKeyFrameCollection.xml index 3afec4fae03..69951e6b8a0 100644 --- a/xml/System.Windows.Media.Animation/RectKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/RectKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreRectKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreRectKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreRectKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreRectKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/RemoveStoryboard.xml b/xml/System.Windows.Media.Animation/RemoveStoryboard.xml index ddb72acbd1e..e546f930bc4 100644 --- a/xml/System.Windows.Media.Animation/RemoveStoryboard.xml +++ b/xml/System.Windows.Media.Animation/RemoveStoryboard.xml @@ -30,10 +30,10 @@ Use with a or to remove a . ## Pause, Resume, Stop, Remove, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, remove, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, remove, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ## When to Remove Storyboards - You should use the action to remove any storyboards begun with a of . It's also a good idea to remove background animations when the object they animate is no longer being used. For example, if you apply an indefinitely repeating storyboard using an element's event, you should also create an that uses a action to remove the storyboard on the element's event. + You should use the action to remove any storyboards begun with a of . It's also a good idea to remove background animations when the object they animate is no longer being used. For example, if you apply an indefinitely repeating storyboard using an element's event, you should also create an that uses a action to remove the storyboard on the element's event. diff --git a/xml/System.Windows.Media.Animation/RepeatBehavior.xml b/xml/System.Windows.Media.Animation/RepeatBehavior.xml index f23d5232758..a18de42cdc3 100644 --- a/xml/System.Windows.Media.Animation/RepeatBehavior.xml +++ b/xml/System.Windows.Media.Animation/RepeatBehavior.xml @@ -42,11 +42,11 @@ behaviors: + There are three types of behaviors: - **Iteration Count** - specifies the number of times the simple duration of a plays. The default iteration count is 1.0, and means the is active for exactly one of its simple durations. A count of 0.5 specifies that the timeline is active for half of its simple duration, while a count of 2 specifies that the timeline repeats its simple duration twice. For more information, see the property. -- **Duration** - specifies the length of the object's active duration. For example, a with a simple value of 1 second and a value of 2.5 seconds will run for 2.5 iterations. +- **Duration** - specifies the length of the object's active duration. For example, a with a simple value of 1 second and a value of 2.5 seconds will run for 2.5 iterations. - **Forever** - the repeats indefinitely. @@ -68,7 +68,7 @@ -or- - \<*object* *property*=""/> + \<*object* *property*=""/> - diff --git a/xml/System.Windows.Media.Animation/ResumeStoryboard.xml b/xml/System.Windows.Media.Animation/ResumeStoryboard.xml index fc6a0399b46..3d60a8d7256 100644 --- a/xml/System.Windows.Media.Animation/ResumeStoryboard.xml +++ b/xml/System.Windows.Media.Animation/ResumeStoryboard.xml @@ -29,7 +29,7 @@ ## Remarks Use this class with an or a to resume a paused . A object can only resume a that is paused and has no effect on a in any other state. - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it starts. For more information, see [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts). + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it starts. For more information, see [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts). ]]> diff --git a/xml/System.Windows.Media.Animation/Rotation3DAnimation.xml b/xml/System.Windows.Media.Animation/Rotation3DAnimation.xml index 91e3c8df5fe..0d9d99a46d6 100644 --- a/xml/System.Windows.Media.Animation/Rotation3DAnimation.xml +++ b/xml/System.Windows.Media.Animation/Rotation3DAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -265,17 +265,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -362,7 +362,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -493,17 +493,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -595,7 +595,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -634,7 +634,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -682,7 +682,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -729,17 +729,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Rotation3DAnimationBase.xml b/xml/System.Windows.Media.Animation/Rotation3DAnimationBase.xml index 0e9087756fa..64ff6330732 100644 --- a/xml/System.Windows.Media.Animation/Rotation3DAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Rotation3DAnimationBase.xml @@ -93,7 +93,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -220,7 +220,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/Rotation3DAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Rotation3DAnimationUsingKeyFrames.xml index 7da3a20913f..88d7150d07f 100644 --- a/xml/System.Windows.Media.Animation/Rotation3DAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Rotation3DAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Rotation3DKeyFrame.xml b/xml/System.Windows.Media.Animation/Rotation3DKeyFrame.xml index 83c433da503..c783758489a 100644 --- a/xml/System.Windows.Media.Animation/Rotation3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Rotation3DKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Rotation3DKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Rotation3DKeyFrameCollection.xml index e9ab2c316d1..2874682a151 100644 --- a/xml/System.Windows.Media.Animation/Rotation3DKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Rotation3DKeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -162,13 +162,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -203,13 +203,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -244,13 +244,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -288,13 +288,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -491,15 +491,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -534,13 +534,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -576,21 +576,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -626,15 +626,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -771,11 +771,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -813,10 +813,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/SeekStoryboard.xml b/xml/System.Windows.Media.Animation/SeekStoryboard.xml index bfdc72441fd..e52da85a190 100644 --- a/xml/System.Windows.Media.Animation/SeekStoryboard.xml +++ b/xml/System.Windows.Media.Animation/SeekStoryboard.xml @@ -29,12 +29,12 @@ ## Remarks Use a action with an or a to seek a . - Note that seek operations do not take the storyboard's or settings into account: the storyboard is treated as though it had a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account: the storyboard is treated as though it had a of 1 and no . Seeking a triggers its and events. ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ]]> @@ -103,19 +103,19 @@ or settings into account: the storyboard is treated as though it had a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account: the storyboard is treated as though it had a of 1 and no . ## XAML Attribute Usage - \<*object* ="[-][*days*.]*hours*:*minutes*:*seconds*[.*fractionalSeconds*]"/> + \<*object* ="[-][*days*.]*hours*:*minutes*:*seconds*[.*fractionalSeconds*]"/> -or- - \<*object* ="[-][*days*.]*hours*:*minutes*"/> + \<*object* ="[-][*days*.]*hours*:*minutes*"/> -or- - \<*object* ="[-]*days*"/> + \<*object* ="[-]*days*"/> ## XAML Values @@ -146,7 +146,7 @@ A value consisting of 1 to 7 digits that represents fractional seconds. - For the complete syntax, see the Remarks section of the page. + For the complete syntax, see the Remarks section of the page. ]]> diff --git a/xml/System.Windows.Media.Animation/SetStoryboardSpeedRatio.xml b/xml/System.Windows.Media.Animation/SetStoryboardSpeedRatio.xml index 80184e5f581..23cbbc765d7 100644 --- a/xml/System.Windows.Media.Animation/SetStoryboardSpeedRatio.xml +++ b/xml/System.Windows.Media.Animation/SetStoryboardSpeedRatio.xml @@ -29,14 +29,14 @@ ## Remarks Use a action with an or a to interactively control a storyboard's speed ratio. - Use the property of to specify a new animation speed as a ratio of the old animation speed. For example, if you set the to 2, you double the speed of the animations and if you set a value of 0.5, you reduce the speed by 50 percent. + Use the property of to specify a new animation speed as a ratio of the old animation speed. For example, if you set the to 2, you double the speed of the animations and if you set a value of 0.5, you reduce the speed by 50 percent. This object affects the at anytime after the begins. For example, if you pause the and use the , when you resume the , it uses the new speed ratio. - does not control a directly. Rather, must reference the of the , which controls the . + does not control a directly. Rather, must reference the of the , which controls the . ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ]]> @@ -114,7 +114,7 @@ animation speed as a ratio of the old animation speed. For example, if you set the to 2, you double the speed of the animations and if you set a value of 0.5, you reduce the speed by 50 percent. + Use this property to specify a new animation speed as a ratio of the old animation speed. For example, if you set the to 2, you double the speed of the animations and if you set a value of 0.5, you reduce the speed by 50 percent. ]]> diff --git a/xml/System.Windows.Media.Animation/SineEase.xml b/xml/System.Windows.Media.Animation/SineEase.xml index 30d52c57a16..0fe5d1a1f3e 100644 --- a/xml/System.Windows.Media.Animation/SineEase.xml +++ b/xml/System.Windows.Media.Animation/SineEase.xml @@ -26,7 +26,7 @@ . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. + You can control when the animation accelerates, decelerates or both by specifying the . The following graph demonstrates the different values of where *f*(*t*) represents the animation progress and *t* represents time. ![SineEase for different EasingMode values](~/add/media/sineease-graph.png "SineEase for different EasingMode values") @@ -37,7 +37,7 @@ There are several other easing functions besides . > [!NOTE] -> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. +> You can use to create the same behavior as , , , and by using the property. For example, if you want to use to substitute for , specify a value of 3. In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from . @@ -128,12 +128,12 @@ . Because of this, you need to override the method to construct a custom animation object. + Animation classes inherit indirectly from . Because of this, you need to override the method to construct a custom animation object. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -175,9 +175,9 @@ case of . + This method transforms normalized time to control the pace of an animation for the case of . - You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. + You only have to specify your easing function for the case because the implementation of the method transforms `normalizedTime` for the and cases. ]]> diff --git a/xml/System.Windows.Media.Animation/SingleAnimation.xml b/xml/System.Windows.Media.Animation/SingleAnimation.xml index 41dfb4cdea8..4cdc34f8571 100644 --- a/xml/System.Windows.Media.Animation/SingleAnimation.xml +++ b/xml/System.Windows.Media.Animation/SingleAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -356,7 +356,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -487,17 +487,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -587,7 +587,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -627,7 +627,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -675,7 +675,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -723,17 +723,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/SingleAnimationBase.xml b/xml/System.Windows.Media.Animation/SingleAnimationBase.xml index f85d42b2bb0..aab08a9e18c 100644 --- a/xml/System.Windows.Media.Animation/SingleAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/SingleAnimationBase.xml @@ -94,7 +94,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -269,7 +269,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/SingleAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/SingleAnimationUsingKeyFrames.xml index 63772e2f434..3bbeff412bb 100644 --- a/xml/System.Windows.Media.Animation/SingleAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/SingleAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/SingleKeyFrame.xml b/xml/System.Windows.Media.Animation/SingleKeyFrame.xml index 2d4cd852c2e..0b0486978f9 100644 --- a/xml/System.Windows.Media.Animation/SingleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SingleKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/SingleKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/SingleKeyFrameCollection.xml index ca366cfa0d8..9ae71a3a564 100644 --- a/xml/System.Windows.Media.Animation/SingleKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/SingleKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreSingleKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreSingleKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreSingleKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreSingleKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/SizeAnimation.xml b/xml/System.Windows.Media.Animation/SizeAnimation.xml index 158afd0de22..93ea088229d 100644 --- a/xml/System.Windows.Media.Animation/SizeAnimation.xml +++ b/xml/System.Windows.Media.Animation/SizeAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you must associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -368,7 +368,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -499,17 +499,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -613,7 +613,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -653,7 +653,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -701,7 +701,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -749,17 +749,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/SizeAnimationBase.xml b/xml/System.Windows.Media.Animation/SizeAnimationBase.xml index 8ea09be664a..b3d41018a70 100644 --- a/xml/System.Windows.Media.Animation/SizeAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/SizeAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/SizeAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/SizeAnimationUsingKeyFrames.xml index 8a56be1aaf2..6f17f8054b7 100644 --- a/xml/System.Windows.Media.Animation/SizeAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/SizeAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/SizeKeyFrame.xml b/xml/System.Windows.Media.Animation/SizeKeyFrame.xml index e80e1312c98..5588b7ac8af 100644 --- a/xml/System.Windows.Media.Animation/SizeKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SizeKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/SizeKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/SizeKeyFrameCollection.xml index bcfecc12971..5fb4d030e12 100644 --- a/xml/System.Windows.Media.Animation/SizeKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/SizeKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreSizeKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreSizeKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreSizeKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreSizeKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/SkipStoryboardToFill.xml b/xml/System.Windows.Media.Animation/SkipStoryboardToFill.xml index b714795c869..c0f5be225ea 100644 --- a/xml/System.Windows.Media.Animation/SkipStoryboardToFill.xml +++ b/xml/System.Windows.Media.Animation/SkipStoryboardToFill.xml @@ -32,7 +32,7 @@ only affects an active (after the starts). ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts) for more information. ]]> diff --git a/xml/System.Windows.Media.Animation/SplineByteKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineByteKeyFrame.xml index 3901be1b4af..9a32499c9e7 100644 --- a/xml/System.Windows.Media.Animation/SplineByteKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineByteKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineColorKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineColorKeyFrame.xml index faf1a24a335..879599a84df 100644 --- a/xml/System.Windows.Media.Animation/SplineColorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineColorKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineDecimalKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineDecimalKeyFrame.xml index c8181971b48..42f8b663075 100644 --- a/xml/System.Windows.Media.Animation/SplineDecimalKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineDecimalKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineDoubleKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineDoubleKeyFrame.xml index 977a841d539..d724fd2d3c9 100644 --- a/xml/System.Windows.Media.Animation/SplineDoubleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineDoubleKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineInt16KeyFrame.xml b/xml/System.Windows.Media.Animation/SplineInt16KeyFrame.xml index c4d44bb8ad9..ecff40d06f5 100644 --- a/xml/System.Windows.Media.Animation/SplineInt16KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineInt16KeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineInt32KeyFrame.xml b/xml/System.Windows.Media.Animation/SplineInt32KeyFrame.xml index 0c202ed03aa..69e7e01081f 100644 --- a/xml/System.Windows.Media.Animation/SplineInt32KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineInt32KeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineInt64KeyFrame.xml b/xml/System.Windows.Media.Animation/SplineInt64KeyFrame.xml index df1c08b1096..ec5b63066c0 100644 --- a/xml/System.Windows.Media.Animation/SplineInt64KeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineInt64KeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplinePoint3DKeyFrame.xml b/xml/System.Windows.Media.Animation/SplinePoint3DKeyFrame.xml index f2fbc994242..bfa22b01aca 100644 --- a/xml/System.Windows.Media.Animation/SplinePoint3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplinePoint3DKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplinePointKeyFrame.xml b/xml/System.Windows.Media.Animation/SplinePointKeyFrame.xml index 9d22d5a0a50..24ddc30cec2 100644 --- a/xml/System.Windows.Media.Animation/SplinePointKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplinePointKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like create a variable transition between values, which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the define those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the define those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineQuaternionKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineQuaternionKeyFrame.xml index 42482873dbd..fb0a49f4b3e 100644 --- a/xml/System.Windows.Media.Animation/SplineQuaternionKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineQuaternionKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like create a variable transition between values that is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -268,7 +268,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the define those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the define those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineRectKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineRectKeyFrame.xml index bb254c7d1d7..20cb693c61b 100644 --- a/xml/System.Windows.Media.Animation/SplineRectKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineRectKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineRotation3DKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineRotation3DKeyFrame.xml index 81ed9ca3c4b..3175bc6fa8b 100644 --- a/xml/System.Windows.Media.Animation/SplineRotation3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineRotation3DKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineSingleKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineSingleKeyFrame.xml index 94fc061f001..61cbe038f42 100644 --- a/xml/System.Windows.Media.Animation/SplineSingleKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineSingleKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineSizeKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineSizeKeyFrame.xml index 4ae63b7e961..2f363935638 100644 --- a/xml/System.Windows.Media.Animation/SplineSizeKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineSizeKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineThicknessKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineThicknessKeyFrame.xml index 47e39b8f27c..a82fd4ee045 100644 --- a/xml/System.Windows.Media.Animation/SplineThicknessKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineThicknessKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineVector3DKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineVector3DKeyFrame.xml index 07a9f0746ff..850d0b4dc3a 100644 --- a/xml/System.Windows.Media.Animation/SplineVector3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineVector3DKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011) . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/SplineVectorKeyFrame.xml b/xml/System.Windows.Media.Animation/SplineVectorKeyFrame.xml index 1bcc625da1b..739149291e3 100644 --- a/xml/System.Windows.Media.Animation/SplineVectorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/SplineVectorKeyFrame.xml @@ -29,7 +29,7 @@ ## Remarks This class is used as part of a in conjunction with a to animate a property value along a set of key frames. - A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. + A key frame defines a segment of the to which it belongs. Each key frame has a target and a . The specifies the time at which the key frame's should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached. Spline key frames like creates a variable transition between values which is determined by the property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration. @@ -269,7 +269,7 @@ works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). + To understand how a works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see [Key Spline Animation Sample](https://go.microsoft.com/fwlink/?LinkID=160011). ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/StopStoryboard.xml b/xml/System.Windows.Media.Animation/StopStoryboard.xml index 085f5afab0b..da66f6a3da6 100644 --- a/xml/System.Windows.Media.Animation/StopStoryboard.xml +++ b/xml/System.Windows.Media.Animation/StopStoryboard.xml @@ -31,10 +31,10 @@ only affects a when it is active (after the starts). Stopping a storyboard triggers the and events, but not the event. - does not reference a directly. Rather, must reference the of the that controls the . See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for an example. + does not reference a directly. Rather, must reference the of the that controls the . See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for an example. ## Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively - To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. + To be able to pause, resume, or otherwise control a interactively, set the property of its and use a object (such as , , or ) to control it by referencing its . If the of is unspecified, the cannot be interactively controlled after it is begun. See [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts) for more information. ]]> diff --git a/xml/System.Windows.Media.Animation/Storyboard.xml b/xml/System.Windows.Media.Animation/Storyboard.xml index f9899c15e03..0ea043c23ac 100644 --- a/xml/System.Windows.Media.Animation/Storyboard.xml +++ b/xml/System.Windows.Media.Animation/Storyboard.xml @@ -30,7 +30,7 @@ ## Remarks ## Interactively Controlling Storyboards - A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in markup, you specify the property of the object that creates it; for an example, see [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts). To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in markup, you specify the property of the object that creates it; for an example, see [How to: Use Event Triggers to Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-use-event-triggers-to-control-a-storyboard-after-it-starts). To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ## Data Binding and Animating Timelines Most timeline properties can be data bound or animated; however, because of the way the timing system works, data bound or animated timelines do not behave like other data bound or animated objects. To understand their behavior, it helps to understand what it means to activate a timeline. @@ -39,9 +39,9 @@ For a timeline to reflect data binding or animation changes, its clock must be re-created. Clocks are not re-created for you automatically. The following are several ways to apply timeline changes: -- If the timeline is or belongs to a , you can make it reflect changes by reapplying its storyboard using a or the method. This has the side effect of also restarting the animation. In code, you can use the method to advance the storyboard back to its previous position. +- If the timeline is or belongs to a , you can make it reflect changes by reapplying its storyboard using a or the method. This has the side effect of also restarting the animation. In code, you can use the method to advance the storyboard back to its previous position. -- If you applied an animation directly to a property using the method, call the method again and pass it the animation that has been modified. +- If you applied an animation directly to a property using the method, call the method again and pass it the animation that has been modified. - If you are working directly at the clock level, create and apply a new set of clocks and use them to replace the previous set of created clocks. @@ -93,7 +93,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -169,7 +169,7 @@ ## Remarks If the targeted properties are already animated, they are replaced using the handoff behavior. - Storyboards started with this method cannot be paused, resumed, or otherwise interactively controlled after they are started. To make a storyboard controllable, use the or method. + Storyboards started with this method cannot be paused, resumed, or otherwise interactively controlled after they are started. To make a storyboard controllable, use the or method. Beginning a storyboard triggers the and events. @@ -226,7 +226,7 @@ ## Remarks If the targeted properties are already animated, they are replaced using the handoff behavior. - Storyboards started with this method cannot be paused, resumed, or otherwise interactively controlled after they are started. To make a storyboard controllable, use the or method. + Storyboards started with this method cannot be paused, resumed, or otherwise interactively controlled after they are started. To make a storyboard controllable, use the or method. Beginning a storyboard triggers the and events. @@ -341,9 +341,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -566,9 +566,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -699,9 +699,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -759,9 +759,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -835,9 +835,9 @@ To avoid performance issues when you apply a large number of clocks using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock. -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -880,7 +880,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -917,12 +917,12 @@ when creating new instances of the class for the various cloning methods (such as and ). + This method is called internally by when creating new instances of the class for the various cloning methods (such as and ). ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -946,9 +946,9 @@ speed is the rate at which its time is currently progressing, compared to real-world time. + A clock's speed is the rate at which its time is currently progressing, compared to real-world time. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1025,9 +1025,9 @@ speed is the rate at which its time is currently progressing, compared to real-world time. + A clock's speed is the rate at which its time is currently progressing, compared to real-world time. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1074,9 +1074,9 @@ speed is the rate at which its time is currently progressing, compared to real-world time. + A clock's speed is the rate at which its time is currently progressing, compared to real-world time. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1125,9 +1125,9 @@ ## Remarks A clock's first iteration has a value of 1. - If this storyboard has a setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. + If this storyboard has a setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1176,9 +1176,9 @@ ## Remarks A clock's first iteration has a value of 1. - If this storyboard has a setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. + If this storyboard has a setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1227,11 +1227,11 @@ ## Remarks A clock's first iteration has a value of 1. - If this clock's timeline has an setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. + If this clock's timeline has an setting of `true`, a full iteration consists of a forward-reverse pair, not just one of these segments. Regardless of its current iteration, seeking a clock returns its current iteration to 1. Restarting a clock also returns its current iteration to 1. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1279,7 +1279,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1326,7 +1326,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1373,7 +1373,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1425,9 +1425,9 @@ method. + This method does not tell you whether a storyboard is paused. To determine whether a storyboard is paused, use the method. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1473,9 +1473,9 @@ method. + This method does not tell you whether a storyboard is paused. To determine whether a storyboard is paused, use the method. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1521,9 +1521,9 @@ method. + This method does not tell you whether a storyboard is paused. To determine whether a storyboard is paused, use the method. - To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1570,7 +1570,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1618,7 +1618,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1666,7 +1666,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1720,7 +1720,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1768,7 +1768,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1816,7 +1816,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -1863,7 +1863,7 @@ attached property with animation timelines to indicate the object that they target. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + Use the attached property with animation timelines to indicate the object that they target. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). ]]> @@ -1904,7 +1904,7 @@ attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + This method gets the attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). ]]> @@ -2001,10 +2001,10 @@ ## Remarks This method pauses the storyboard, but has no discernible effect if it is not active or currently paused. As a side effect, all associated children are also paused. - A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ## Beginning a Paused Storyboard - When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces the paused with a new unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. + When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces the paused with a new unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. ]]> @@ -2051,14 +2051,14 @@ ## Remarks This method pauses the storyboard, but has no discernible effect if it is not active or currently paused. As a side effect, all associated children are also paused. - Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method again replaces the paused storyboard with a new one, which has the appearance of resuming it. + Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method again replaces the paused storyboard with a new one, which has the appearance of resuming it. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. Fro an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. Fro an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Pausing a storyboard's clock triggers the event. ## Beginning a Paused Storyboard - When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces itself with an unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. + When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces itself with an unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. @@ -2114,14 +2114,14 @@ ## Remarks This method pauses the storyboard, but has no discernible effect if it is not active or currently paused. As a side effect, all associated children are also paused. - Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method again replaces the paused storyboard with a new one, which has the appearance of resuming it. + Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method again replaces the paused storyboard with a new one, which has the appearance of resuming it. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Pausing a storyboard's clock triggers the event. ## Beginning a Paused Storyboard - When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces itself with an unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. + When you a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The method actually replaces itself with an unpaused version. Each time the method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the method is called again, it does not restart its clocks; it replaces them with new clocks. ]]> @@ -2173,9 +2173,9 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). - All interactive actions taken on a , and therefore also on a , occur on the next tick of the timing engine, which happens shortly before the next render. This means that the method still affects the animated properties until this time. In other words, the next time the frame is displayed, the storyboard is removed. If you need to disassociate an animation from a property before this time, use the method with an `animation` parameter value of `null`. + All interactive actions taken on a , and therefore also on a , occur on the next tick of the timing engine, which happens shortly before the next render. This means that the method still affects the animated properties until this time. In other words, the next time the frame is displayed, the storyboard is removed. If you need to disassociate an animation from a property before this time, use the method with an `animation` parameter value of `null`. ]]> @@ -2220,7 +2220,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Removing a storyboard's clock triggers the event. @@ -2267,7 +2267,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Removing a storyboard's clock triggers the event. @@ -2320,7 +2320,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -2367,9 +2367,9 @@ ## Remarks Resuming a storyboard that is not paused has no effect. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). - Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method after the storyboard has started replaces the old storyboard, which has the appearance of resuming it. + Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method after the storyboard has started replaces the old storyboard, which has the appearance of resuming it. Resuming a paused a storyboard's clock triggers the event. @@ -2427,9 +2427,9 @@ ## Remarks Resuming a storyboard that is not paused has no effect. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). - Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method after the storyboard has started replaces the old storyboard, which has the appearance of resuming it. + Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the method. Calling the method after the storyboard has started replaces the old storyboard, which has the appearance of resuming it. Resuming a paused a storyboard's clock triggers the event. @@ -2486,9 +2486,9 @@ or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -2535,9 +2535,9 @@ or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -2586,18 +2586,18 @@ or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - This method changes the storyboard clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events are also not raised until then. + This method changes the storyboard clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events are also not raised until then. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Seeking a storyboard triggers the and events. ## Examples - The following example shows both the and methods. + The following example shows both the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/RegisterName/FrameworkContentElementSeekExample.cs" id="Snippetframeworkcontentelementseekexampleusingwholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/RegisterName/frameworkcontentelementseekexample.vb" id="Snippetframeworkcontentelementseekexampleusingwholepage"::: @@ -2649,11 +2649,11 @@ or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - This method changes the storyboard clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events are also not raised until then. + This method changes the storyboard clock's to . This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events are also not raised until then. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed if it is made controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed if it is made controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Seeking a storyboard triggers the and events. @@ -2665,7 +2665,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/UIElement/ApplyAnimationClock/SeekStoryboardExample.cs" id="Snippetseekstoryboardexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/UIElement/ApplyAnimationClock/seekstoryboardexample.vb" id="Snippetseekstoryboardexamplewholepage"::: - The next example shows both the and methods. + The next example shows both the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/RegisterName/SeekExample.cs" id="Snippetseekexampleusingwholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/RegisterName/seekexample.vb" id="Snippetseekexampleusingwholepage"::: @@ -2723,11 +2723,11 @@ aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. + aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. - Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -2774,11 +2774,11 @@ aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. + aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. - Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -2827,22 +2827,22 @@ aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. + aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. - Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - This method changes the storyboard clock's to + This method changes the storyboard clock's to . Seeking a storyboard triggers the and events. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ## Examples - The following example shows both the and methods. + The following example shows both the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/RegisterName/FrameworkContentElementSeekExample.cs" id="Snippetframeworkcontentelementseekexampleusingwholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/RegisterName/frameworkcontentelementseekexample.vb" id="Snippetframeworkcontentelementseekexampleusingwholepage"::: @@ -2894,22 +2894,22 @@ aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. + aligns the seeked time of the with the last clock tick. Values are immediately updated to reflect the changes due to , even though the screen does not reflect these changes until the screen updates. - Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . + Note that seek operations do not take the storyboard's or settings into account. The storyboard is treated as though it has a of 1 and no . - This method changes the storyboard clock's to + This method changes the storyboard clock's to . Seeking a storyboard triggers the and events. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ## Examples - The following example shows both the and methods. + The following example shows both the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/RegisterName/SeekExample.cs" id="Snippetseekexampleusingwholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/RegisterName/seekexample.vb" id="Snippetseekexampleusingwholepage"::: @@ -2966,7 +2966,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -3013,7 +3013,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Calling this method triggers the event. @@ -3070,7 +3070,7 @@ method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). Calling this method triggers the event. @@ -3113,7 +3113,7 @@ attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + This method sets the attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). > [!NOTE] > The property is not serializable, because it can be set to any . It is not guaranteed that this object can be correctly referenced from XAML. @@ -3158,7 +3158,7 @@ attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + This method sets the attached property on the specified object. For more information about how storyboard targeting works, see . For more information about how attached properties work, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). ]]> @@ -3253,7 +3253,7 @@ This method sets the method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -3298,13 +3298,13 @@ This method sets the setting. If is set to , the storyboard fills; if the property is set to , the storyboard stops. + This method advances the storyboard's current time to the end of its active period; the storyboard's behavior at this point is specified by its setting. If is set to , the storyboard fills; if the property is set to , the storyboard stops. Calling this method on a storyboard with an infinite duration, an infinite number of repetitions has no effect. Calling this method on an inactive storyboard has no effect. Advancing a clock to its fill period triggers the and events. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). @@ -3357,13 +3357,13 @@ This method sets the setting. If is set to , the storyboard fills; if the property is set to , the storyboard stops. + This method advances the storyboard's current time to the end of its active period; the storyboard's behavior at this point is specified by its setting. If is set to , the storyboard fills; if the property is set to , the storyboard stops. Calling this method on a storyboard with an infinite duration, an infinite number of repetitions has no effect. Calling this method on an inactive storyboard has no effect. Advancing a clock to its fill period triggers the and events. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -3463,7 +3463,7 @@ This method sets the and events, but not the event. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). @@ -3520,7 +3520,7 @@ This method sets the and events, but not the event. - To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). + To interactively control this storyboard, you must use the same `containingObject` parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's method and specify `true` to make it controllable. For an example, see [How to: Control a Storyboard After It Starts](/dotnet/framework/wpf/graphics-multimedia/how-to-control-a-storyboard-after-it-starts). ]]> @@ -3593,13 +3593,13 @@ This method sets the is not specified, a storyboard's animations are applied to one of the following: + Setting this property is optional. If the is not specified, a storyboard's animations are applied to one of the following: - If the storyboard to which the animation belongs was started using a , the element that owns the action that triggers the storyboard is targeted. -- If the storyboard was started using the method, the or specified when the storyboard was started with the method is targeted. +- If the storyboard was started using the method, the or specified when the storyboard was started with the method is targeted. - When this property is set on a timeline with children, those child timelines "inherit" the parent's unless they specify their own. + When this property is set on a timeline with children, those child timelines "inherit" the parent's unless they specify their own. ## Making an Object Targetable When using XAML, you perform one of the following two actions to make an object targetable by a storyboard: @@ -3608,7 +3608,7 @@ This method sets the or a custom or , assign it a name using the [x:Name Directive](/dotnet/framework/xaml-services/x-name-directive) markup extension. - When using code, you make an object targetable by using the method to assign the object a name. + When using code, you make an object targetable by using the method to assign the object a name. ## Dependency Property Information diff --git a/xml/System.Windows.Media.Animation/StringAnimationBase.xml b/xml/System.Windows.Media.Animation/StringAnimationBase.xml index a479668eba5..7970473cf80 100644 --- a/xml/System.Windows.Media.Animation/StringAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/StringAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/StringAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/StringAnimationUsingKeyFrames.xml index cb6a623f2ab..bbf37b7325c 100644 --- a/xml/System.Windows.Media.Animation/StringAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/StringAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. ]]> @@ -198,7 +198,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -237,9 +237,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -278,7 +278,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -317,9 +317,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -425,11 +425,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -468,9 +468,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -514,7 +514,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. diff --git a/xml/System.Windows.Media.Animation/StringKeyFrame.xml b/xml/System.Windows.Media.Animation/StringKeyFrame.xml index fe8035f23f0..a9f2db7ba63 100644 --- a/xml/System.Windows.Media.Animation/StringKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/StringKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/StringKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/StringKeyFrameCollection.xml index 91117fba641..e15c9d40bed 100644 --- a/xml/System.Windows.Media.Animation/StringKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/StringKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreStringKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreStringKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreStringKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreStringKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -595,21 +595,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -645,15 +645,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -790,11 +790,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -832,10 +832,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/ThicknessAnimation.xml b/xml/System.Windows.Media.Animation/ThicknessAnimation.xml index 6327a658c06..79893bd1a8b 100644 --- a/xml/System.Windows.Media.Animation/ThicknessAnimation.xml +++ b/xml/System.Windows.Media.Animation/ThicknessAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -259,17 +259,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -368,7 +368,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -499,17 +499,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -611,7 +611,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -651,7 +651,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -699,7 +699,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -747,17 +747,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/ThicknessAnimationBase.xml b/xml/System.Windows.Media.Animation/ThicknessAnimationBase.xml index 87dc2d5c71c..fc36dfd2361 100644 --- a/xml/System.Windows.Media.Animation/ThicknessAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/ThicknessAnimationBase.xml @@ -103,7 +103,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -162,7 +162,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -220,7 +220,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -278,7 +278,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/ThicknessAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/ThicknessAnimationUsingKeyFrames.xml index aeb0a9063f7..5127f428bb9 100644 --- a/xml/System.Windows.Media.Animation/ThicknessAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/ThicknessAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -429,11 +429,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -472,9 +472,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -518,7 +518,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -623,7 +623,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/ThicknessKeyFrame.xml b/xml/System.Windows.Media.Animation/ThicknessKeyFrame.xml index 8541daa5bb4..92785a370c4 100644 --- a/xml/System.Windows.Media.Animation/ThicknessKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/ThicknessKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/ThicknessKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/ThicknessKeyFrameCollection.xml index 9f80d9c19e5..ac39c383941 100644 --- a/xml/System.Windows.Media.Animation/ThicknessKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/ThicknessKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreThicknessKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreThicknessKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreThicknessKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreThicknessKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -510,15 +510,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -553,13 +553,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -596,21 +596,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -646,15 +646,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -791,11 +791,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -833,10 +833,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/Timeline.xml b/xml/System.Windows.Media.Animation/Timeline.xml index 582197a3c57..cda923a6ca7 100644 --- a/xml/System.Windows.Media.Animation/Timeline.xml +++ b/xml/System.Windows.Media.Animation/Timeline.xml @@ -58,9 +58,9 @@ For a timeline to reflect data binding or animation changes, its clock must be regenerated. Clocks are not regenerated for you automatically. The following are several ways to apply timeline changes: -- If the timeline is or belongs to a , you can make it reflect changes by reapplying its storyboard using a or the method. This has the side effect of also restarting the animation. In code, you can use the method to advance the storyboard back to its previous position. +- If the timeline is or belongs to a , you can make it reflect changes by reapplying its storyboard using a or the method. This has the side effect of also restarting the animation. In code, you can use the method to advance the storyboard back to its previous position. -- If you applied an animation directly to a property using the method, call the method again and pass it the animation that's been modified. +- If you applied an animation directly to a property using the method, call the method again and pass it the animation that's been modified. - If you are working directly at the clock level, create and apply a new set of clocks and use them to replace the previous set of generated clocks. @@ -176,9 +176,9 @@ + - + ]]> @@ -218,9 +218,9 @@ + - + ]]> @@ -256,7 +256,7 @@ property to create animations that start slowly and then speed up as time progresses. The property is useful for creating ease-in effects or making movement seem more natural. Use the and properties together to create animations that start slowly, speed up, and then slow down again before finishing. + Use the property to create animations that start slowly and then speed up as time progresses. The property is useful for creating ease-in effects or making movement seem more natural. Use the and properties together to create animations that start slowly, speed up, and then slow down again before finishing. ## Dependency Property Information @@ -333,7 +333,7 @@ method and should not be called directly by your code. + This method is called by the method and should not be called directly by your code. ]]> @@ -382,7 +382,7 @@ If the property is set to `true`, the timeline plays for twice the length of time specified by its property. ### AutoReverse and Repetitions - When a timeline's property is set to `true` and its property causes it to repeat, each forward iteration is followed by a backward iteration. This makes one repetition. For example, a timeline with an value of `true` with an iteration of 2 would play forward once, then backwards, then forwards again, and then backwards again. + When a timeline's property is set to `true` and its property causes it to repeat, each forward iteration is followed by a backward iteration. This makes one repetition. For example, a timeline with an value of `true` with an iteration of 2 would play forward once, then backwards, then forwards again, and then backwards again. ## Dependency Property Information @@ -455,15 +455,15 @@ property is useful for creating timelines that play in a sequence: by increasing the of successive timelines that share the same parent, you can stagger their play times. + The property is useful for creating timelines that play in a sequence: by increasing the of successive timelines that share the same parent, you can stagger their play times. ## Negative Values - A negative value causes a to behave as though it started at some time in the past. For example, a with a of negative 2.5 seconds and a of 5 seconds will appear to be half-way finished when it starts. + A negative value causes a to behave as though it started at some time in the past. For example, a with a of negative 2.5 seconds and a of 5 seconds will appear to be half-way finished when it starts. ## BeginTime and SpeedRatio - The time described by the property is measured in the timeline's parent's time. For example, a timeline with a of 5 whose parent has a of 2 actually starts after 2.5 seconds. + The time described by the property is measured in the timeline's parent's time. For example, a timeline with a of 5 whose parent has a of 2 actually starts after 2.5 seconds. - A timeline's own setting does not affect its . For example, a timeline with a of 5 seconds, a of 2, and a parent timeline with a of 1 starts after 5 seconds, not 2.5. + A timeline's own setting does not affect its . For example, a timeline with a of 5 seconds, a of 2, and a parent timeline with a of 1 starts after 5 seconds, not 2.5. ## Dependency Property Information @@ -475,19 +475,19 @@ ## XAML Attribute Usage - \<*object* ="[-][*days*.]*hours*:*minutes*:*seconds*[.*fractionalSeconds*]"/> + \<*object* ="[-][*days*.]*hours*:*minutes*:*seconds*[.*fractionalSeconds*]"/> -or- - \<*object* ="[-][*days*.]*hours*:*minutes*"/> + \<*object* ="[-][*days*.]*hours*:*minutes*"/> -or- - \<*object* ="[-]*days*"/> + \<*object* ="[-]*days*"/> -or- - \<*object* ="{[x:Null Markup Extension](/dotnet/framework/xaml-services/x-null-markup-extension)}"/> + \<*object* ="{[x:Null Markup Extension](/dotnet/framework/xaml-services/x-null-markup-extension)}"/> ## XAML Values @@ -518,14 +518,14 @@ A value consisting of 1 to 7 digits that represents fractional seconds. - For the complete syntax, see the Remarks section of the page. + For the complete syntax, see the Remarks section of the page. ## Examples A timeline's property determines the beginning of a timeline's active period. If the timeline has a parent timeline, the property determines how long it takes the timeline to start after its parent starts. If the timeline is a root timeline (a , for example), the property determines how long the timeline takes to start playing after it is triggered. - The following example shows several different timelines with different settings. + The following example shows several different timelines with different settings. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/Timeline/BeginTime/BeginTimeExample.xaml" id="Snippet_graphicsmm_begintimeexamplewholepage"::: @@ -595,7 +595,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. @@ -636,7 +636,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . Resource references, data bindings, and animations are not copied, but their current values are. @@ -818,17 +818,17 @@ ## Remarks The current global speed of a timeline's clock changes in the following circumstances: -- The clock changes direction because of its timeline's setting. +- The clock changes direction because of its timeline's setting. -- The clock accelerates or decelerates because of its timeline's or property settings. +- The clock accelerates or decelerates because of its timeline's or property settings. - The clock is paused or resumed. - The clock becomes inactive or reactivates. -- The of one of the clock's parent changes. +- The of one of the clock's parent changes. - The event is useful for tracking when a timeline's clock becomes paused; in your event handler, use your storyboard's method or check the clock's property to determine whether its clock is paused; compare this against a previously cached value to determine whether it changed. + The event is useful for tracking when a timeline's clock becomes paused; in your event handler, use your storyboard's method or check the clock's property to determine whether its clock is paused; compare this against a previously cached value to determine whether it changed. The parameter of the event handler is the timeline's . @@ -880,7 +880,7 @@ ## Remarks Use the event when you want to be notified when a timeline's starts, stops, or fills. - Pausing a does not change its . To be notified when a clock becomes paused, use the event. + Pausing a does not change its . To be notified when a clock becomes paused, use the event. Although this event occurs when the becomes invalid, that doesn't necessarily mean the changed: a that switches from to and then back to in the same tick will cause this event to fire, but its property won't actually change. @@ -924,7 +924,7 @@ event when you want to be notified when the of a timeline's is updated. + Use the event when you want to be notified when the of a timeline's is updated. The parameter of the event handler is the timeline's . @@ -972,7 +972,7 @@ property to create animations that slow down before stopping. The property is useful for creating ease-in effects or making movement seem more natural. Use the and properties together to create animations that start slowly, speed up, and then slow down again before finishing. + Use the property to create animations that slow down before stopping. The property is useful for creating ease-in effects or making movement seem more natural. Use the and properties together to create animations that start slowly, speed up, and then slow down again before finishing. ## Dependency Property Information @@ -1122,7 +1122,7 @@ The following example uses the DesiredFrameRate property to limit several animat A timeline's simple duration constitutes the time for a single forward iteration versus the total play time, which includes repetitions. ## Default Duration Behavior - The behavior of a structure with a value of depends on the type of timeline: + The behavior of a structure with a value of depends on the type of timeline: |**Timeline**|**Behavior**| |-|-| @@ -1156,7 +1156,7 @@ The following example uses the DesiredFrameRate property to limit several animat ... ``` - Examples of \<*Type*>Animations include , , , etc. If no is specified for these types of animations, they will run for one second. + Examples of \<*Type*>Animations include , , , etc. If no is specified for these types of animations, they will run for one second. ```xaml ... @@ -1166,7 +1166,7 @@ The following example uses the DesiredFrameRate property to limit several animat ... ``` - Examples of \<*Type*>AnimationUsingKeyFrames include , , etc. If no is specified for these types of animations they will run until all key frames are finished. + Examples of \<*Type*>AnimationUsingKeyFrames include , , etc. If no is specified for these types of animations they will run until all key frames are finished. ```xaml ... @@ -1248,13 +1248,13 @@ The following example uses the DesiredFrameRate property to limit several animat property to when you want the animation to hold its value after it reaches the end of its active period. An animation that has reached the end of its active period that has a setting of is said to be in its fill period. When you don't want an animation to hold its value after it reaches the end of its active period, set its + Set an animations property to when you want the animation to hold its value after it reaches the end of its active period. An animation that has reached the end of its active period that has a setting of is said to be in its fill period. When you don't want an animation to hold its value after it reaches the end of its active period, set its property to . Because an animation in its fill period continues to override its target property's value, attempting to set the target property's value through other means might appear to have no effect. For an example showing how to set a property value after it has been animated, see [How to: Set a Property After Animating It with a Storyboard](/dotnet/framework/wpf/graphics-multimedia/how-to-set-a-property-after-animating-it-with-a-storyboard). - A child timeline stops playing and filling when its parent timeline stops; if you want a child timeline to fill, make sure its parent timeline has a of . + A child timeline stops playing and filling when its parent timeline stops; if you want a child timeline to fill, make sure its parent timeline has a of . ## Dependency Property Information @@ -1333,7 +1333,7 @@ The following example uses the DesiredFrameRate property to limit several animat . + Do not call this method directly (except when calling base in an implementation). This method is called internally by . ]]> @@ -1379,11 +1379,11 @@ The following example uses the DesiredFrameRate property to limit several animat will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -1422,9 +1422,9 @@ The following example uses the DesiredFrameRate property to limit several animat method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -1464,7 +1464,7 @@ The following example uses the DesiredFrameRate property to limit several animat attached property. For more information, see the page. + This method provides read access to the attached property. For more information, see the page. ]]> @@ -1511,9 +1511,9 @@ The following example uses the DesiredFrameRate property to limit several animat property is set to . If is , the natural duration is determined by that particular class's implementation of . + This method should only be called when the property is set to . If is , the natural duration is determined by that particular class's implementation of . - If returns , it means that the natural duration is unknown, which implies a natural duration of . Such is the case for streaming media. + If returns , it means that the natural duration is unknown, which implies a natural duration of . Such is the case for streaming media. Note that passing this method a clock other than the one that was created for this timeline is possible, but will provide unreliable results. @@ -1557,7 +1557,7 @@ The following example uses the DesiredFrameRate property to limit several animat and should not be called directly from your code. Use instead. + This method provides the implementation for and should not be called directly from your code. Use instead. ]]> @@ -1663,7 +1663,7 @@ The following example uses the DesiredFrameRate property to limit several animat action to a storyboard, using a Storyboard's method, or (when working directly with clocks) calling the method. + This event is raised by applying a action to a storyboard, using a Storyboard's method, or (when working directly with clocks) calling the method. Although this event handler appears to be associated with a timeline, it actually registers with the created for this timeline. For more information, see the [Timing Events Overview](/dotnet/framework/wpf/graphics-multimedia/timing-events-overview). @@ -1704,9 +1704,9 @@ The following example uses the DesiredFrameRate property to limit several animat is specified and the timeline's property is set to `true`, a single repetition consists of one forward iteration and one backward iteration. A timeline with an property set to true an iteration of 2 would play forwards, then backwards, then forwards again, and then backwards again. + If an iteration is specified and the timeline's property is set to `true`, a single repetition consists of one forward iteration and one backward iteration. A timeline with an property set to true an iteration of 2 would play forwards, then backwards, then forwards again, and then backwards again. - Instead of specifying the number of times a timeline plays, you can also specify the total length of time you want the timeline to play. For a timeline to repeat, this value should be greater than the timeline's . For example, a timeline with a of 2 seconds and a of 4 seconds will play twice. If the is less than the timeline's , the timeline's active period is cut short. + Instead of specifying the number of times a timeline plays, you can also specify the total length of time you want the timeline to play. For a timeline to repeat, this value should be greater than the timeline's . For example, a timeline with a of 2 seconds and a of 4 seconds will play twice. If the is less than the timeline's , the timeline's active period is cut short. For more information about repeating timelines, see [Animation Overview](/dotnet/framework/wpf/graphics-multimedia/animation-overview). @@ -1786,7 +1786,7 @@ The following example uses the DesiredFrameRate property to limit several animat attached property. For more information, see the page. + This method sets the attached property. For more information, see the page. ]]> @@ -1829,9 +1829,9 @@ The following example uses the DesiredFrameRate property to limit several animat setting does not have an effect on its ; that time is relative to the timeline's parent or, if the timeline is a root timeline, the moment at which the timeline's clock was begun. + A timeline's setting does not have an effect on its ; that time is relative to the timeline's parent or, if the timeline is a root timeline, the moment at which the timeline's clock was begun. - If or are specified, this is the average ratio over the natural length of the timeline. + If or are specified, this is the average ratio over the natural length of the timeline. ## Dependency Property Information @@ -1844,7 +1844,7 @@ The following example uses the DesiredFrameRate property to limit several animat ## Examples - A timeline's property controls its rate of progress, relative to its parent. If the timeline is a root, its is relative to the default timeline speed. The following example shows several timelines with different settings. + A timeline's property controls its rate of progress, relative to its parent. If the timeline is a root, its is relative to the default timeline speed. The following example shows several timelines with different settings. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Animation/Timeline/BeginTime/SpeedExample.xaml" id="Snippet_graphicsmm_speedexamplewholepage"::: diff --git a/xml/System.Windows.Media.Animation/TimelineCollection.xml b/xml/System.Windows.Media.Animation/TimelineCollection.xml index 74371f368fc..adc3f7aae5a 100644 --- a/xml/System.Windows.Media.Animation/TimelineCollection.xml +++ b/xml/System.Windows.Media.Animation/TimelineCollection.xml @@ -51,26 +51,26 @@ Represents a collection of objects. - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreTimelineObjectElements - - -``` - - -## XAML Values - *oneOrMoreTimelineObjectElements* - One or more objects, declared using object element syntax. - + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreTimelineObjectElements + + +``` + + +## XAML Values + *oneOrMoreTimelineObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -265,13 +265,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -336,13 +336,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -858,11 +858,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -898,11 +898,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -942,11 +942,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -982,11 +982,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1021,11 +1021,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1061,11 +1061,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1104,11 +1104,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1148,11 +1148,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1191,11 +1191,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1235,11 +1235,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1275,11 +1275,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1315,11 +1315,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1364,11 +1364,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1406,11 +1406,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media.Animation/TimelineGroup.xml b/xml/System.Windows.Media.Animation/TimelineGroup.xml index fff1903e576..cac09650def 100644 --- a/xml/System.Windows.Media.Animation/TimelineGroup.xml +++ b/xml/System.Windows.Media.Animation/TimelineGroup.xml @@ -391,7 +391,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -430,7 +430,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -469,7 +469,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Animation/Vector3DAnimation.xml b/xml/System.Windows.Media.Animation/Vector3DAnimation.xml index e8d6105c30c..52bd982668c 100644 --- a/xml/System.Windows.Media.Animation/Vector3DAnimation.xml +++ b/xml/System.Windows.Media.Animation/Vector3DAnimation.xml @@ -31,18 +31,18 @@ An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value. ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -265,17 +265,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -374,7 +374,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -505,17 +505,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -619,7 +619,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -658,7 +658,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -706,7 +706,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ## Dependency Property Information @@ -754,17 +754,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/Vector3DAnimationBase.xml b/xml/System.Windows.Media.Animation/Vector3DAnimationBase.xml index f95c7772e25..38fd3d04fb5 100644 --- a/xml/System.Windows.Media.Animation/Vector3DAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/Vector3DAnimationBase.xml @@ -93,7 +93,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -152,7 +152,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -210,7 +210,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -268,7 +268,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/Vector3DAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/Vector3DAnimationUsingKeyFrames.xml index 212dd3132d6..9fa0eb17b27 100644 --- a/xml/System.Windows.Media.Animation/Vector3DAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/Vector3DAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -200,7 +200,7 @@ method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited method to provide a strongly typed implementation. + The method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited method to provide a strongly typed implementation. ]]> @@ -481,7 +481,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -586,7 +586,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/Vector3DKeyFrame.xml b/xml/System.Windows.Media.Animation/Vector3DKeyFrame.xml index da26f3d7b93..efaf845152c 100644 --- a/xml/System.Windows.Media.Animation/Vector3DKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/Vector3DKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/Vector3DKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/Vector3DKeyFrameCollection.xml index 68884c4f9e4..30d0deca3fd 100644 --- a/xml/System.Windows.Media.Animation/Vector3DKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/Vector3DKeyFrameCollection.xml @@ -35,11 +35,11 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - + to animate a property value along a set of key frames. + ]]> @@ -165,13 +165,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -206,13 +206,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -247,13 +247,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -291,13 +291,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -459,8 +459,8 @@ to check if this instance can be frozen; to freeze this instance. Makes this instance of unmodifiable or determines whether it can be made unmodifiable. - If is true, this method returns if this instance can be made read-only, or if it cannot be made read-only. - + If is true, this method returns if this instance can be made read-only, or if it cannot be made read-only. + If is false, this method returns if this instance is now read-only, or if it cannot be made read-only, with the side effect of having begun to change the frozen status of this object. To be added. @@ -496,15 +496,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -539,13 +539,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -581,21 +581,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -631,15 +631,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -776,11 +776,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -818,10 +818,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Animation/VectorAnimation.xml b/xml/System.Windows.Media.Animation/VectorAnimation.xml index 7086ed01ad8..e6dd4412a84 100644 --- a/xml/System.Windows.Media.Animation/VectorAnimation.xml +++ b/xml/System.Windows.Media.Animation/VectorAnimation.xml @@ -30,18 +30,18 @@ ## Remarks ## Target Values - The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + The class creates a transition between two target values. To set its target values, use its , , and properties. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties specified|Resulting behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| > [!NOTE] -> If you set both the and properties, the property takes precedence and the property is ignored. +> If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -258,17 +258,17 @@ property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. + Use the property when you want to animate a value "by" a certain amount, rather than specifying a starting or ending value. You may also use the property with the property. The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -367,7 +367,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -498,17 +498,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. @@ -612,7 +612,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -652,7 +652,7 @@ , , or properties set, setting this property has no effect. + If the animation has only one of its , , or properties set, setting this property has no effect. ## Dependency Property Information @@ -697,7 +697,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> @@ -734,17 +734,17 @@ , , and properties may be used together or separately to determine an animation's target values. + The following table summarizes how the , , and properties may be used together or separately to determine an animation's target values. |Properties Specified|Resulting Behavior| |--------------------------|------------------------| -||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| -| and |The animation progresses from the value specified by the property to the value specified by the property.| -| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| -||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| -||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| +||The animation progresses from the value specified by the property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.| +| and |The animation progresses from the value specified by the property to the value specified by the property.| +| and |The animation progresses from the value specified by the property to the value specified by the sum of the and properties.| +||The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the property.| +||The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the property.| - **Note** If you set both the and properties, the property takes precedence and the property is ignored. + **Note** If you set both the and properties, the property takes precedence and the property is ignored. To use other interpolation methods or animate between more than two target values, use a object. diff --git a/xml/System.Windows.Media.Animation/VectorAnimationBase.xml b/xml/System.Windows.Media.Animation/VectorAnimationBase.xml index 0d9aacb58f6..6c9585123a8 100644 --- a/xml/System.Windows.Media.Animation/VectorAnimationBase.xml +++ b/xml/System.Windows.Media.Animation/VectorAnimationBase.xml @@ -94,7 +94,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -211,7 +211,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. @@ -269,7 +269,7 @@ - If the animation is in the first position in a composition chain and no animation exists to replace, `defaultOriginValue` is the base value of the animated property. -- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . +- If this animation is not in the first position of a composition chain, then `defaultOriginValue` is the value that is returned by the previous animation in the composition chain that has an that is not . The value of the `defaultDestinationValue` parameter depends on whether there is a previous property composition layer. diff --git a/xml/System.Windows.Media.Animation/VectorAnimationUsingKeyFrames.xml b/xml/System.Windows.Media.Animation/VectorAnimationUsingKeyFrames.xml index bd1f7f461e2..1db57a9b692 100644 --- a/xml/System.Windows.Media.Animation/VectorAnimationUsingKeyFrames.xml +++ b/xml/System.Windows.Media.Animation/VectorAnimationUsingKeyFrames.xml @@ -41,7 +41,7 @@ property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. + A key frame animation's target values are defined by its property, which contains a collection of objects. Each defines a segment of the animation with its own target and . When the animation runs, it progresses from one key value to the next at the specified key times. There are three types of classes, one for each supported interpolation method: , , and . @@ -202,7 +202,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -241,9 +241,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -282,7 +282,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -321,9 +321,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -431,11 +431,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -474,9 +474,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> @@ -520,7 +520,7 @@ that is not . + If the `defaultOriginValue` is the first in the composition chain, this value will be the snapshot value (if one is available) or the base property value; otherwise this value will be the value returned by the previous animation in the chain with an that is not . The `defaultDestinationValue` is the base value if the animation is in the first composition layer of animations on a property; otherwise the value is the output value from the previous composition layer of animations for the property. @@ -625,7 +625,7 @@ property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. + When this property is set to `true`, the animation's output values only accumulate when the animation's property causes it to repeat its simple duration. It does not accumulate its values when it restarts because its parent repeated or because its clock was restarted from a call. ]]> diff --git a/xml/System.Windows.Media.Animation/VectorKeyFrame.xml b/xml/System.Windows.Media.Animation/VectorKeyFrame.xml index b36522b5ae7..c54f3c19a32 100644 --- a/xml/System.Windows.Media.Animation/VectorKeyFrame.xml +++ b/xml/System.Windows.Media.Animation/VectorKeyFrame.xml @@ -169,7 +169,7 @@ of the previous key frame. + The base value is typically the initial value of the property being animated or the of the previous key frame. Most implementations will return the value of `baseValue` when `keyFrameProgress` is 0.0. diff --git a/xml/System.Windows.Media.Animation/VectorKeyFrameCollection.xml b/xml/System.Windows.Media.Animation/VectorKeyFrameCollection.xml index 34b0a841eee..54637995cd7 100644 --- a/xml/System.Windows.Media.Animation/VectorKeyFrameCollection.xml +++ b/xml/System.Windows.Media.Animation/VectorKeyFrameCollection.xml @@ -35,27 +35,27 @@ Represents a collection of objects. - to animate a property value along a set of key frames. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreVectorKeyFrameObjectElements - - -``` - - -## XAML Values - *oneOrMoreVectorKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + to animate a property value along a set of key frames. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreVectorKeyFrameObjectElements + + +``` + + +## XAML Values + *oneOrMoreVectorKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -181,13 +181,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -222,13 +222,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -263,13 +263,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -307,13 +307,13 @@ if the collection contains ; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -475,8 +475,8 @@ to check if this instance can be frozen; to freeze this instance. Makes this instance of read-only or determines whether it can be made read-only. - If is true, this method returns if this instance can be made read-only, or if it cannot be made read-only. - + If is true, this method returns if this instance can be made read-only, or if it cannot be made read-only. + If is false, this method returns if this instance is now read-only, or if it cannot be made read-only, with the side effect of having begun to change the frozen status of this object. To be added. @@ -512,15 +512,15 @@ The object to clone. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -555,13 +555,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> @@ -597,21 +597,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -647,15 +647,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -792,11 +792,11 @@ if access to the collection is synchronized (thread-safe); otherwise, . - @@ -834,10 +834,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . diff --git a/xml/System.Windows.Media.Effects/BevelBitmapEffect.xml b/xml/System.Windows.Media.Effects/BevelBitmapEffect.xml index 28093afd2ba..76baabda8e7 100644 --- a/xml/System.Windows.Media.Effects/BevelBitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/BevelBitmapEffect.xml @@ -212,7 +212,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -251,7 +251,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/BitmapEffect.xml b/xml/System.Windows.Media.Effects/BitmapEffect.xml index d64e35998ca..0837f62af88 100644 --- a/xml/System.Windows.Media.Effects/BitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/BitmapEffect.xml @@ -38,7 +38,7 @@ Scale transforms are applied to a visual before an effect is applied. In the event of a non-uniform scale transform, the effect will use the larger of the scale values. - Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can work around this limitation by forcing an update of the scene on the parent object of the effect. You can call or include an animation to force a scene update. + Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can work around this limitation by forcing an update of the scene on the parent object of the effect. You can call or include an animation to force a scene update. Custom effects inherit this class to create a managed interface to the unmanaged effect. For more information, see the [Unmanaged BitmapEffect](https://msdn.microsoft.com/library/ms735092.aspx) API. @@ -117,7 +117,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -156,7 +156,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -207,7 +207,7 @@ method. + Framework interaction with custom effects is handled through an [IMILBitmapEffect](/windows/win32/api/mileffects/nn-mileffects-imilbitmapeffect) object. The outer effect is initialized with the custom effect through the method. ]]> @@ -391,7 +391,7 @@ . When you override , use to update unmanaged property values. + This method is intended as a helper method for . When you override , use to update unmanaged property values. ]]> @@ -440,7 +440,7 @@ . + When setting unmanaged properties within an override of this method, use the helper method . ]]> diff --git a/xml/System.Windows.Media.Effects/BitmapEffectCollection.xml b/xml/System.Windows.Media.Effects/BitmapEffectCollection.xml index 04c70f0dd19..7d0bc270448 100644 --- a/xml/System.Windows.Media.Effects/BitmapEffectCollection.xml +++ b/xml/System.Windows.Media.Effects/BitmapEffectCollection.xml @@ -241,13 +241,13 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version. + + For more information, see . + ]]> @@ -312,13 +312,13 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version. + + For more information, see . + ]]> @@ -390,13 +390,13 @@ if the collection contains value; otherwise, . - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -842,11 +842,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -882,11 +882,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -926,11 +926,11 @@ The first position in the specified to receive the copied contents. **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -966,11 +966,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1005,11 +1005,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1045,11 +1045,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1088,11 +1088,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1132,11 +1132,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1175,11 +1175,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1219,11 +1219,11 @@ The to insert into the . **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1259,11 +1259,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1299,11 +1299,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1348,11 +1348,11 @@ **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1390,11 +1390,11 @@ The to remove from the . **Note: This API is now obsolete.** The non-obsolete alternative is . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media.Effects/BitmapEffectGroup.xml b/xml/System.Windows.Media.Effects/BitmapEffectGroup.xml index e1cb022c46a..07574e75c73 100644 --- a/xml/System.Windows.Media.Effects/BitmapEffectGroup.xml +++ b/xml/System.Windows.Media.Effects/BitmapEffectGroup.xml @@ -146,7 +146,7 @@ Effects in a BitmapEffectGroup dependency property. + The identifier for the dependency property. ]]> @@ -185,7 +185,7 @@ Effects in a BitmapEffectGroup ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -224,7 +224,7 @@ Effects in a BitmapEffectGroup ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/BitmapEffectInput.xml b/xml/System.Windows.Media.Effects/BitmapEffectInput.xml index d7c6b4a54d3..03b3c3ab4cc 100644 --- a/xml/System.Windows.Media.Effects/BitmapEffectInput.xml +++ b/xml/System.Windows.Media.Effects/BitmapEffectInput.xml @@ -135,7 +135,7 @@ or equal to **0**, the effect will not be applied to the visual. + When the rectangle has a or equal to **0**, the effect will not be applied to the visual. expresses different behavior depending on whether the background of the element is transparent or not. If no background is present or defined, only considers the children for its size and the starting point for coordinates begin where the visual rendering starts. @@ -283,7 +283,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -322,7 +322,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/BlurBitmapEffect.xml b/xml/System.Windows.Media.Effects/BlurBitmapEffect.xml index e03adecc961..9cade28e0c7 100644 --- a/xml/System.Windows.Media.Effects/BlurBitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/BlurBitmapEffect.xml @@ -118,7 +118,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -157,7 +157,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -275,7 +275,7 @@ ## Examples - The following example shows how to specify the of a . + The following example shows how to specify the of a . :::code language="xaml" source="~/snippets/csharp/System.Windows/UIElement/BitmapEffect/blursimpleexample.xaml" id="Snippetblursimpleexamplewholepage"::: @@ -341,7 +341,7 @@ . + A larger radius implies more blurring. The amount of blurring is also affected by the kernel used to create the blur, see . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Effects/DropShadowBitmapEffect.xml b/xml/System.Windows.Media.Effects/DropShadowBitmapEffect.xml index a5e43c60db8..7a868e7ea93 100644 --- a/xml/System.Windows.Media.Effects/DropShadowBitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/DropShadowBitmapEffect.xml @@ -104,7 +104,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -143,7 +143,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/Effect.xml b/xml/System.Windows.Media.Effects/Effect.xml index 65797e8f884..194c611cd05 100644 --- a/xml/System.Windows.Media.Effects/Effect.xml +++ b/xml/System.Windows.Media.Effects/Effect.xml @@ -99,7 +99,7 @@ method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. + The method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. ]]> @@ -140,7 +140,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -179,7 +179,7 @@ ## Remarks Override the property to assign a transform that differs from the default identity transform. - Input is transformed through the inverse of this transform. The and methods also have the transform applied. + Input is transformed through the inverse of this transform. The and methods also have the transform applied. Incoming points must be in the [0-1] range, and outgoing points must map to the [0-1] range. The property must return a that computes the inverse mapping. @@ -238,7 +238,7 @@ The property represents the shader input that comes from the rendering of the that the is applied to. > [!NOTE] -> The behavior is undefined when is used as a Brush in other WPF classes. +> The behavior is undefined when is used as a Brush in other WPF classes. ]]> diff --git a/xml/System.Windows.Media.Effects/EmbossBitmapEffect.xml b/xml/System.Windows.Media.Effects/EmbossBitmapEffect.xml index a7f8502fc0d..50a74dbb9ee 100644 --- a/xml/System.Windows.Media.Effects/EmbossBitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/EmbossBitmapEffect.xml @@ -46,7 +46,7 @@ ![Screenshot: Compare image with and without emboss](~/add/media/effects-embosssimple.png "Screenshot: Compare image with and without emboss") - The visual effect of an emboss can be modified using the and properties. + The visual effect of an emboss can be modified using the and properties. ]]> @@ -116,7 +116,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -155,7 +155,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/OuterGlowBitmapEffect.xml b/xml/System.Windows.Media.Effects/OuterGlowBitmapEffect.xml index 0db056b186d..d195bb9ec89 100644 --- a/xml/System.Windows.Media.Effects/OuterGlowBitmapEffect.xml +++ b/xml/System.Windows.Media.Effects/OuterGlowBitmapEffect.xml @@ -132,7 +132,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -171,7 +171,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -500,7 +500,7 @@ ![Screenshot: Compare glow opacity property values](~/add/media/effects-outerglowopacity.png "Screenshot: Compare glow opacity property values") - Opacity can also be specified using the alpha value of . + Opacity can also be specified using the alpha value of . ## Dependency Property Information diff --git a/xml/System.Windows.Media.Effects/PixelShader.xml b/xml/System.Windows.Media.Effects/PixelShader.xml index a7b4bb86d91..ef50a59f8c7 100644 --- a/xml/System.Windows.Media.Effects/PixelShader.xml +++ b/xml/System.Windows.Media.Effects/PixelShader.xml @@ -31,7 +31,7 @@ ## Remarks Use the class to access pre-compiled HLSL bytecode in a Windows Presentation Foundation (WPF) application. You can create a from a Pack URI reference or from a . - Set the property or call the method to load the shader bytecode. + Set the property or call the method to load the shader bytecode. To create a custom effect, assign the to the property of a . @@ -97,7 +97,7 @@ method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. + The method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. ]]> @@ -170,7 +170,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Effects/ShaderEffect.xml b/xml/System.Windows.Media.Effects/ShaderEffect.xml index 9204b6a67a6..d6687808c73 100644 --- a/xml/System.Windows.Media.Effects/ShaderEffect.xml +++ b/xml/System.Windows.Media.Effects/ShaderEffect.xml @@ -34,7 +34,7 @@ 1. Load a from precompiled High Level Shading Language (HLSL) bytecode. -2. Define dependency properties that represent the parameters of the effect and the -based surface inputs. Use one of the overloads to associate these inputs with register numbers that are referenced in the HLSL bytecode. +2. Define dependency properties that represent the parameters of the effect and the -based surface inputs. Use one of the overloads to associate these inputs with register numbers that are referenced in the HLSL bytecode. The number of samplers is limited to 4. @@ -136,7 +136,7 @@ method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. + The method can be used to produce modifiable copies of frozen objects. For convenience, this method shadows the inherited method to provide a strongly typed implementation. ]]> @@ -209,7 +209,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -308,7 +308,7 @@ property to specify the shader register that contains the partial derivatives of the texture coordinates with respect to screen space. For example, if is set to 4, the shader register c4 is used. Register c4 contains four float fields. The following High Level Shading Language (HLSL) code shows how this register is used. The `nextPixelUV` value represents the next pixel to the right. + Use the property to specify the shader register that contains the partial derivatives of the texture coordinates with respect to screen space. For example, if is set to 4, the shader register c4 is used. Register c4 contains four float fields. The following High Level Shading Language (HLSL) code shows how this register is used. The `nextPixelUV` value represents the next pixel to the right. ```hlsl float4 ddxUvDdyUv : register(c4); @@ -321,7 +321,7 @@ nextPixelUV.v = ddxUvDdyUv.y + v; tex2D(sampler, nextPixelUV); ``` - The following table shows how the register specified for is filled. + The following table shows how the register specified for is filled. |Register Constant|Derivative Value| |-----------------------|----------------------| @@ -609,7 +609,7 @@ tex2D(sampler, nextPixelUV); method when you register a dependency property for a shader constant. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader constant register specified by `floatRegisterIndex`. + Use the method when you register a dependency property for a shader constant. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader constant register specified by `floatRegisterIndex`. ]]> @@ -699,7 +699,7 @@ tex2D(sampler, nextPixelUV); method when you register a -valued dependency property for a shader sampler. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader sampler register specified by `samplerRegisterIndex`. + Use the method when you register a -valued dependency property for a shader sampler. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader sampler register specified by `samplerRegisterIndex`. ]]> @@ -743,7 +743,7 @@ tex2D(sampler, nextPixelUV); method when you register a -valued dependency property for a shader sampler. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader sampler register specified by `samplerRegisterIndex`. + Use the method when you register a -valued dependency property for a shader sampler. The method constructs a delegate that, when invoked, creates an association between the dependency property and the shader sampler register specified by `samplerRegisterIndex`. ]]> diff --git a/xml/System.Windows.Media.Imaging/BitmapCodecInfo.xml b/xml/System.Windows.Media.Imaging/BitmapCodecInfo.xml index 43f961266f3..67e1e7fdfbd 100644 --- a/xml/System.Windows.Media.Imaging/BitmapCodecInfo.xml +++ b/xml/System.Windows.Media.Imaging/BitmapCodecInfo.xml @@ -27,7 +27,7 @@ can be obtain for each codec in Windows Presentation Foundation (WPF) by using the or the properties. + A can be obtain for each codec in Windows Presentation Foundation (WPF) by using the or the properties. diff --git a/xml/System.Windows.Media.Imaging/BitmapCreateOptions.xml b/xml/System.Windows.Media.Imaging/BitmapCreateOptions.xml index d050aafac28..57276d708d8 100644 --- a/xml/System.Windows.Media.Imaging/BitmapCreateOptions.xml +++ b/xml/System.Windows.Media.Imaging/BitmapCreateOptions.xml @@ -29,23 +29,23 @@ Specifies initialization options for bitmap images. - of the image is chosen by the system depending on what the system determines will yield the best performance. Enabling this option preserves the file format but may result in lesser performance. - - If `IgnoreColorProfile` is set, calls to methods such as will not return color-corrected bits. - - If `IgnoreImageCache` is set, any existing entries in the image cache are replaced even if they share the same . - - - -## Examples - The following example demonstrates how to instantiate a and specify a `BitmapCreateOptions` enumeration value. - + of the image is chosen by the system depending on what the system determines will yield the best performance. Enabling this option preserves the file format but may result in lesser performance. + + If `IgnoreColorProfile` is set, calls to methods such as will not return color-corrected bits. + + If `IgnoreImageCache` is set, any existing entries in the image cache are replaced even if they share the same . + + + +## Examples + The following example demonstrates how to instantiate a and specify a `BitmapCreateOptions` enumeration value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Windows.Media.Imaging/BitmapDecoder.xml b/xml/System.Windows.Media.Imaging/BitmapDecoder.xml index d45e25971a0..759f3785ed3 100644 --- a/xml/System.Windows.Media.Imaging/BitmapDecoder.xml +++ b/xml/System.Windows.Media.Imaging/BitmapDecoder.xml @@ -37,12 +37,12 @@ ## Examples - The following example demonstrates how to use the method to create a decoder for a given image. The first of the image is used as the source of an control. + The following example demonstrates how to use the method to create a decoder for a given image. The first of the image is used as the source of an control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.cs" id="Snippetbitmapdecodercreate"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.vb" id="Snippetbitmapdecodercreate"::: - The following code example demonstrates how to use the built in to open and decode a Tagged Image File Format (TIFF) bitmap. The resulting is used as the of an element. + The following code example demonstrates how to use the built in to open and decode a Tagged Image File Format (TIFF) bitmap. The resulting is used as the of an element. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet4"::: @@ -218,7 +218,7 @@ ## Examples - The following example demonstrates how to use the method to create a decoder for a given image. The first of the image is used as the source of an control. + The following example demonstrates how to use the method to create a decoder for a given image. The first of the image is used as the source of an control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.cs" id="Snippetbitmapdecodercreatestream"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.vb" id="Snippetbitmapdecodercreatestream"::: @@ -272,7 +272,7 @@ method to create a decoder for a given image. The first of the image is used as the source of an control. + The following example demonstrates how to use the method to create a decoder for a given image. The first of the image is used as the source of an control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.cs" id="Snippetbitmapdecodercreate"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/BitmapDecoderExample.vb" id="Snippetbitmapdecodercreate"::: @@ -324,7 +324,7 @@ is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. ]]> @@ -526,7 +526,7 @@ . Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. + This method overrides . Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. For more information, see [Finalize Methods and Destructors](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/0s71x931(v%3dvs.100)), [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged), and [Overriding the Finalize Method](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). diff --git a/xml/System.Windows.Media.Imaging/BitmapFrame.xml b/xml/System.Windows.Media.Imaging/BitmapFrame.xml index d3f13247c64..e1be4a244fa 100644 --- a/xml/System.Windows.Media.Imaging/BitmapFrame.xml +++ b/xml/System.Windows.Media.Imaging/BitmapFrame.xml @@ -31,9 +31,9 @@ provides additional functionality not defined by by providing access to the associated with a particular frame of an image. also supports the writing of metadata information by using the property or the method. + provides additional functionality not defined by by providing access to the associated with a particular frame of an image. also supports the writing of metadata information by using the property or the method. - Any returned from a decoder is always frozen. If you require a modifiable copy, you must first create a copy of the by using the method. + Any returned from a decoder is always frozen. If you require a modifiable copy, you must first create a copy of the by using the method. Only Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF) format images support multiple frames. @@ -45,7 +45,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet1"::: - The following code example demonstrates how to use the object to open a Portable Network Graphics (PNG) graphic and write metadata by using the method. + The following code example demonstrates how to use the object to open a Portable Network Graphics (PNG) graphic and write metadata by using the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: @@ -194,7 +194,7 @@ cache option is used. The default cache option retains the stream until the frame is needed. Use the method to specify create and cache options. + The `bitmapStream` can be closed after the frame is created only when the cache option is used. The default cache option retains the stream until the frame is needed. Use the method to specify create and cache options. ]]> @@ -318,7 +318,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -486,7 +486,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -562,12 +562,12 @@ if the image file contains enough room for the new metadata; otherwise, metadata can be added using the property. + Metadata can only be added or edited using the if the image file contains enough room for the new metadata; otherwise, metadata can be added using the property. ## Examples - The following code example demonstrates how to use the object to open a Portable Network Graphics (PNG) graphic and write metadata by using the method. + The following code example demonstrates how to use the object to open a Portable Network Graphics (PNG) graphic and write metadata by using the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: diff --git a/xml/System.Windows.Media.Imaging/BitmapImage.xml b/xml/System.Windows.Media.Imaging/BitmapImage.xml index 45123658355..bfca8a092c7 100644 --- a/xml/System.Windows.Media.Imaging/BitmapImage.xml +++ b/xml/System.Windows.Media.Imaging/BitmapImage.xml @@ -37,9 +37,9 @@ ## Remarks primarily exists to support Extensible Application Markup Language (XAML) syntax and introduces additional properties for bitmap loading that are not defined by . - implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. + implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. - objects created using the constructor are automatically initialized and property changes are ignored. + objects created using the constructor are automatically initialized and property changes are ignored. @@ -93,7 +93,7 @@ implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. + implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. ]]> @@ -178,7 +178,7 @@ ## Remarks objects created using this constructor are automatically initialized. After initialization, property changes are ignored. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -254,12 +254,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: @@ -305,7 +305,7 @@ to if you wish to close a stream used to create the . The default cache option retains access to the stream until the image is needed, and cleanup is handled by the garbage collector. + Set the to if you wish to close a stream used to create the . The default cache option retains access to the stream until the image is needed, and cleanup is handled by the garbage collector. ## Dependency Property Information @@ -318,7 +318,7 @@ ## Examples - The following code example demonstrates how to set the of a by using code. + The following code example demonstrates how to set the of a by using code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: @@ -389,7 +389,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. @@ -463,7 +463,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version. - For more information, see . + For more information, see . ]]> @@ -574,7 +574,7 @@ ## Examples - The following code example demonstrates how to set the of a by using code. + The following code example demonstrates how to set the of a by using code. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: @@ -642,7 +642,7 @@ is also set, the aspect ratio of the bitmap is ignored. If is not set, the aspect ratio remains the same. + If is also set, the aspect ratio of the bitmap is ignored. If is not set, the aspect ratio remains the same. The JPEG and Portable Network Graphics (PNG) codecs natively decode the image to the specified size; other codecs decode the image at its original size and scale the image to the desired size. @@ -725,7 +725,7 @@ is also set, the aspect ratio of the bitmap is ignored. If is not set, the aspect ratio remains the same. + If is also set, the aspect ratio of the bitmap is ignored. If is not set, the aspect ratio remains the same. The JPEG and Portable Network Graphics (PNG) codecs natively decode the image to the specified size; other codecs decode the image at its original size and scale the image to the desired size. @@ -811,12 +811,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet1"::: @@ -999,7 +999,7 @@ of , a of 10, and of 5 will result in an image that has a width of 5 and a height of 10. + Rotation is performed after scaling. This means that an image that has a of , a of 10, and of 5 will result in an image that has a width of 5 and a height of 10. ## Dependency Property Information @@ -1159,7 +1159,7 @@ and are both set, the value is ignored. + If and are both set, the value is ignored. Set the property to if you wish to close the stream after the is created. The default cache option retains access to the stream until the bitmap is needed, and cleanup is handled by the garbage collector. @@ -1240,7 +1240,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -1313,7 +1313,7 @@ and are both set, the value is ignored. + If and are both set, the value is ignored. ## Dependency Property Information diff --git a/xml/System.Windows.Media.Imaging/BitmapMetadata.xml b/xml/System.Windows.Media.Imaging/BitmapMetadata.xml index c428badbae6..9e11dfb0454 100644 --- a/xml/System.Windows.Media.Imaging/BitmapMetadata.xml +++ b/xml/System.Windows.Media.Imaging/BitmapMetadata.xml @@ -32,25 +32,25 @@ Provides support for reading and writing metadata to and from a bitmap image. - is exposed by a that is obtained by using a , it is read-only by default and mutable operations will throw an exception. If it is exposed by a that wraps another , it is mutable on construction. - - The and methods can be used to construct and read metadata queries. - - - -## Examples - The following example demonstrates how to write metadata to a Tagged Image File Format (TIFF) image by using the IFD and Exif schemas. - + is exposed by a that is obtained by using a , it is read-only by default and mutable operations will throw an exception. If it is exposed by a that wraps another , it is mutable on construction. + + The and methods can be used to construct and read metadata queries. + + + +## Examples + The following example demonstrates how to write metadata to a Tagged Image File Format (TIFF) image by using the IFD and Exif schemas. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet7"::: + ]]> @@ -95,14 +95,14 @@ The format of the bitmap image, specified as "gif", "jpg", "png", or "tiff". Initializes a new instance of for use with the specified image format. - @@ -142,14 +142,14 @@ Gets or sets a value that identifies the name of the application that was used to construct or alter an image file. The name of the application that was used to construct or alter an image file. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -181,14 +181,14 @@ Gets or sets a value that represents the author of an image. The author of the image. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -226,14 +226,14 @@ Gets or sets a value that identifies the camera manufacturer that is associated with an image. The camera manufacturer that is associated with an image. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -271,14 +271,14 @@ Gets or sets a value that identifies the camera model that was used to capture the image. The camera model that was used to capture the image. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -311,15 +311,15 @@ Creates a modifiable clone of this , making deep copies of this object's values. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version. - - For more information, see . - - When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - + objects (or any object). For convenience, this method shadows the inherited version. + + For more information, see . + + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. + ]]> @@ -355,15 +355,15 @@ The to clone. Makes this instance a deep copy of the specified . - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - - When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. + ]]> @@ -399,13 +399,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -444,14 +444,14 @@ Gets or sets a value that represents a comment that is associated with the image file. A comment that is associated with the image file. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -494,13 +494,13 @@ if the query string is found within the metadata store; otherwise, . - @@ -544,14 +544,14 @@ Gets or sets a value that indicates copyright information that is associated with the image file. The copyright information that is associated with the image file. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -614,14 +614,14 @@ Gets or sets a value that indicates the date that the image was taken. The date that the image was taken. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -659,14 +659,14 @@ Gets a value that identifies the format of the image. The format of the bitmap image. - object and send their values to a as strings. - + object and send their values to a as strings. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: + ]]> @@ -701,15 +701,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -745,13 +745,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -794,28 +794,28 @@ Provides access to a metadata query reader that can extract metadata from a bitmap image file. The metadata at the specified query location. - method to write metadata to a Portable Network Graphics (PNG) file. - + method to write metadata to a Portable Network Graphics (PNG) file. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: - - After the metadata is written, the method is used to read that data and emit it as a text string. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: + + After the metadata is written, the method is used to read that data and emit it as a text string. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetgetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetgetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetgetquery"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetgetquery"::: + ]]> @@ -854,14 +854,14 @@ if the is a fixed size; otherwise, . The default value is . - object and send their values to a as strings. - + object and send their values to a as strings. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: + ]]> @@ -894,14 +894,14 @@ if the metadata is read-only; otherwise, . The default value is . - object and send their values to a as strings. - + object and send their values to a as strings. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: + ]]> @@ -968,14 +968,14 @@ Gets a value that identifies the base location of the metadata that is associated with an image. The base location of the image metadata. - object and send their values to a as strings. - + object and send their values to a as strings. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet9"::: + ]]> Portable Network Graphics Textual Data (tEXt) Specification @@ -1049,13 +1049,13 @@ The metadata query to remove. Removes a metadata query from an instance of . - @@ -1105,28 +1105,28 @@ The value of the metadata to be written. Provides access to a metadata query writer that can write metadata to a bitmap image file. - method to write metadata to a Portable Network Graphics (PNG) file. - + method to write metadata to a Portable Network Graphics (PNG) file. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: - - After the metadata is written, the method is used to read that data and emit it as a text string. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: + + After the metadata is written, the method is used to read that data and emit it as a text string. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetgetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetgetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetgetquery"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetgetquery"::: + ]]> Portable Network Graphics Textual Data (tEXt) Specification @@ -1168,14 +1168,14 @@ Gets or sets a value that indicates the subject matter of the bitmap image. The subject of the bitmap image. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> @@ -1221,11 +1221,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1271,11 +1271,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1313,14 +1313,14 @@ Gets or sets a value that identifies the title of an image file. The title of an image file. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet8"::: + ]]> diff --git a/xml/System.Windows.Media.Imaging/BitmapPalettes.xml b/xml/System.Windows.Media.Imaging/BitmapPalettes.xml index 39ca7a2cf5c..f5fdfb9ce8c 100644 --- a/xml/System.Windows.Media.Imaging/BitmapPalettes.xml +++ b/xml/System.Windows.Media.Imaging/BitmapPalettes.xml @@ -1170,7 +1170,7 @@ is identical to the palette. + The is identical to the palette. @@ -1222,7 +1222,7 @@ is identical to the palette. + The is identical to the palette. properties whose names end with "Transparent" have an additional "color" that is fully transparent. In the case of palettes that already have 256 colors, the last color is replaced by the transparent color. diff --git a/xml/System.Windows.Media.Imaging/BitmapSizeOptions.xml b/xml/System.Windows.Media.Imaging/BitmapSizeOptions.xml index 1b0964a8e95..f04ba8a05ef 100644 --- a/xml/System.Windows.Media.Imaging/BitmapSizeOptions.xml +++ b/xml/System.Windows.Media.Imaging/BitmapSizeOptions.xml @@ -58,7 +58,7 @@ will have its property set to , its set to `true`, its set to zero, and its set to zero. + The returned will have its property set to , its set to `true`, its set to zero, and its set to zero. When passed to a , the input is the same as the output. @@ -100,7 +100,7 @@ will have its property set to , its set to `true`, its set to the value of `pixelHeight`, and its set to zero. + The returned will have its property set to , its set to `true`, its set to the value of `pixelHeight`, and its set to zero. ]]> @@ -143,7 +143,7 @@ ## Remarks The resulting bitmap maintains its original aspect ratio and sizing. - The returned will have its property set to the value of `rotation`, its set to `true`, its set to 0, and its set to 0. + The returned will have its property set to the value of `rotation`, its set to `true`, its set to 0, and its set to 0. ]]> @@ -184,7 +184,7 @@ will have its property set to , its set to `true`, its set to zero, and its set to the value of `pixelWidth`. + The returned will have its property set to , its set to `true`, its set to zero, and its set to the value of `pixelWidth`. ]]> @@ -229,7 +229,7 @@ ## Remarks The resulting bitmap has an effective size of `pixelHeight` × `pixelWidth`. - The returned will have its property set to , its set to `false`, its set to the value of `pixelHeight`, and its set to the value of `pixelWidth`. + The returned will have its property set to , its set to `false`, its set to the value of `pixelHeight`, and its set to the value of `pixelWidth`. ]]> @@ -272,7 +272,7 @@ must be greater than zero to be valid. + must be greater than zero to be valid. ]]> @@ -314,7 +314,7 @@ must be greater than zero to be valid. + must be greater than zero to be valid. ]]> @@ -357,7 +357,7 @@ and represent the maximum size values for the bitmap. The resulting bitmap is only guaranteed to have either its width or its height match the specified values. If the aspect ratio is not preserved, the specified and are both used, and the bitmap is stretched to use those values. + If the original aspect ratio is preserved, and represent the maximum size values for the bitmap. The resulting bitmap is only guaranteed to have either its width or its height match the specified values. If the aspect ratio is not preserved, the specified and are both used, and the bitmap is stretched to use those values. ]]> diff --git a/xml/System.Windows.Media.Imaging/BitmapSource.xml b/xml/System.Windows.Media.Imaging/BitmapSource.xml index c6a5a5a396d..369498aaecd 100644 --- a/xml/System.Windows.Media.Imaging/BitmapSource.xml +++ b/xml/System.Windows.Media.Imaging/BitmapSource.xml @@ -31,30 +31,30 @@ Represents a single, constant set of pixels at a certain size and resolution. - is the basic building block of the Windows Presentation Foundation (WPF) imaging pipeline, conceptually representing a single, constant set of pixels at a certain size and resolution. A could be a single frame in an image file that a decoder provides, or it could be the result of a transform that operates on a of its own. is not used to represent a multi-frame image or an animation. - - Windows Presentation Foundation (WPF) natively supports compression and decompression of bitmap (BMP), Graphics Interchange Format (GIF), Joint Photographics Experts Group (JPEG), Portable Network Graphics (PNG), and Tagged Image File Format (TIFF) images. - - For bitmap decoding scenarios, uses automatic codec discovery, based on the installed codecs on the user's system. - - The maximum height and width of an image is 2^16 pixels at 32 bits per channel * 4 channels. The maximum size of a is 2^32 bytes (64 gigabytes) and the maximum image size is four gigapixels. The minimum image size is 1x1. - - - -## Examples - The following code example demonstrates how to create a and use it as the source of an control. - + is the basic building block of the Windows Presentation Foundation (WPF) imaging pipeline, conceptually representing a single, constant set of pixels at a certain size and resolution. A could be a single frame in an image file that a decoder provides, or it could be the result of a transform that operates on a of its own. is not used to represent a multi-frame image or an animation. + + Windows Presentation Foundation (WPF) natively supports compression and decompression of bitmap (BMP), Graphics Interchange Format (GIF), Joint Photographics Experts Group (JPEG), Portable Network Graphics (PNG), and Tagged Image File Format (TIFF) images. + + For bitmap decoding scenarios, uses automatic codec discovery, based on the installed codecs on the user's system. + + The maximum height and width of an image is 2^16 pixels at 32 bits per channel * 4 channels. The maximum size of a is 2^32 bytes (64 gigabytes) and the maximum image size is four gigapixels. The minimum image size is 1x1. + + + +## Examples + The following code example demonstrates how to create a and use it as the source of an control. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/BitmapSourceExample.cs" id="Snippetbitmapsourcecreate"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/BitmapSourceExample.vb" id="Snippetbitmapsourcecreate"::: - - The following code example uses a derived class, , to create a bitmap from an image file and use it as the source of an control. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/BitmapSourceExample.vb" id="Snippetbitmapsourcecreate"::: + + The following code example uses a derived class, , to create a bitmap from an image file and use it as the source of an control. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapImage/Overview/SimpleImageExample.xaml.cs" id="Snippetsimplecsharp1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Imaging/BitmapImage/Overview/SimpleImageExample.xaml.vb" id="Snippetsimplecsharp1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Imaging/BitmapImage/Overview/SimpleImageExample.xaml.vb" id="Snippetsimplecsharp1"::: + ]]> @@ -134,11 +134,11 @@ Checks whether the bitmap source content is from a known site of origin. This method is used to make sure that pixel copying operations are safe. - that is from a site of origin or that is defined in a `pack:`. In all other conditions, this method will fail. - + that is from a site of origin or that is defined in a `pack:`. In all other conditions, this method will fail. + ]]> @@ -171,13 +171,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -212,13 +212,13 @@ The to clone. Makes this instance a deep copy of the specified . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. - method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -252,13 +252,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -294,13 +294,13 @@ The to clone. Makes this instance a modifiable deep copy of the specified using current property values. Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - - For more information, see . - + method and should not be called directly from your code, except when you call the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -399,11 +399,11 @@ The pixel location where copying begins. Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset. - @@ -450,11 +450,11 @@ The stride of the bitmap. Copies the bitmap pixel data within the specified rectangle. - @@ -513,14 +513,14 @@ Creates a new from an array of pixels. The that is created from the specified array of pixels. - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapCodecInfo/Overview/BitmapFrame.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapFrameExample/VB/BitmapFrame.vb" id="Snippet1"::: + ]]> @@ -608,15 +608,15 @@ Occurs when the image fails to load, due to a corrupt image header. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - -## XAML Text Usage - \<*object* DecodeFailed="*EventHandler*" .../> - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + +## XAML Text Usage + \<*object* DecodeFailed="*EventHandler*" .../> + ]]> @@ -647,11 +647,11 @@ Occurs when the bitmap content has been completely downloaded. - @@ -682,15 +682,15 @@ Occurs when the bitmap content failed to download. - -## XAML Text Usage - \<*object* DownloadFailed="*EventHandler*" .../> - + +## XAML Text Usage + \<*object* DownloadFailed="*EventHandler*" .../> + ]]> @@ -721,15 +721,15 @@ Occurs when the download progress of the bitmap content has changed. - -## XAML Text Usage - \<*object* DownloadProgress="*EventHandler*" .../> - + +## XAML Text Usage + \<*object* DownloadProgress="*EventHandler*" .../> + ]]> @@ -819,11 +819,11 @@ Gets the native of the bitmap data. The pixel format of the bitmap data. - is directly readable, this is the format that the pixels will be in when they are read. - + is directly readable, this is the format that the pixels will be in when they are read. + ]]> @@ -859,8 +859,8 @@ if this instance should actually freeze itself when this method is called; otherwise, . Makes an instance of or a derived class immutable. - If is , this method returns if this can be made unmodifiable, or if it cannot be made unmodifiable. - + If is , this method returns if this can be made unmodifiable, or if it cannot be made unmodifiable. + If is , this method returns if the if this is now unmodifiable, or if it cannot be made unmodifiable, with the side effect of having begun to change the frozen status of this object. To be added. @@ -896,15 +896,15 @@ The object to clone and freeze. Makes this instance a clone of the specified object. - will fail when trying to freeze the object and will throw an . - - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information, see . - + will fail when trying to freeze the object and will throw an . + + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information, see . + ]]> @@ -939,13 +939,13 @@ The to copy and freeze. Makes this instance a frozen clone of the specified . Resource references, data bindings, and animations are not copied, but their current values are. - method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - - For more information see . - + method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + + For more information see . + ]]> diff --git a/xml/System.Windows.Media.Imaging/CachedBitmap.xml b/xml/System.Windows.Media.Imaging/CachedBitmap.xml index f675c2b2d7f..515113a51e8 100644 --- a/xml/System.Windows.Media.Imaging/CachedBitmap.xml +++ b/xml/System.Windows.Media.Imaging/CachedBitmap.xml @@ -24,19 +24,19 @@ Provides caching functionality for a . - does not cache bitmap data automatically. Using a can improve performance in scenarios where multiple operations (such as clipping an image or scaling) need to be performed on a single bitmap. - - - -## Examples - The following code example shows how to create and use a in code. - + does not cache bitmap data automatically. Using a can improve performance in scenarios where multiple operations (such as clipping an image or scaling) need to be performed on a single bitmap. + + + +## Examples + The following code example shows how to create and use a in code. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/CachedBitmap/Overview/CachedBitmapExample.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/CachedBitmap/VB/CachedBitmapExample.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/CachedBitmap/VB/CachedBitmapExample.vb" id="Snippet4"::: + ]]> @@ -73,14 +73,14 @@ Specifies how the bitmap is cached to memory. Initializes a new instance of that has the specified source, bitmap create options, and bitmap cache option. - in code. - + in code. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/CachedBitmap/Overview/CachedBitmapExample.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/CachedBitmap/VB/CachedBitmapExample.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/CachedBitmap/VB/CachedBitmapExample.vb" id="Snippet4"::: + ]]> Occurs when is . @@ -115,13 +115,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -196,13 +196,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media.Imaging/ColorConvertedBitmap.xml b/xml/System.Windows.Media.Imaging/ColorConvertedBitmap.xml index 6b746053b5c..c815c702f0c 100644 --- a/xml/System.Windows.Media.Imaging/ColorConvertedBitmap.xml +++ b/xml/System.Windows.Media.Imaging/ColorConvertedBitmap.xml @@ -34,9 +34,9 @@ ## Remarks For XAML usage information, see [ColorConvertedBitmap Markup Extension](/dotnet/framework/wpf/advanced/colorconvertedbitmap-markup-extension). - implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. + implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. - objects created using the constructor are automatically initialized, and property changes are ignored. + objects created using the constructor are automatically initialized, and property changes are ignored. A is never cached. @@ -87,7 +87,7 @@ implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. + implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. ]]> @@ -134,7 +134,7 @@ ## Examples - The following example shows how to initialize an instance of by using the constructor. + The following example shows how to initialize an instance of by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet2"::: @@ -180,12 +180,12 @@ and calls. After the has been initialized, property changes are ignored. + Property initialization must be done between and calls. After the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet3"::: @@ -234,7 +234,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -305,7 +305,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -403,7 +403,7 @@ , the changes must be done within a and block. + When you make property changes to a , the changes must be done within a and block. ## Dependency Property Information @@ -484,7 +484,7 @@ , the changes must be done within a and block. + When you make property changes to a , the changes must be done within a and block. ## Dependency Property Information @@ -575,12 +575,12 @@ and calls. After the has been initialized, property changes are ignored. + Property initialization must be done between and calls. After the has been initialized, property changes are ignored. ## Examples - The following example shows how to use the method in order to change the properties of a . + The following example shows how to use the method in order to change the properties of a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet3"::: @@ -690,7 +690,7 @@ , the changes must be done within a and block. + When you make property changes to a , the changes must be done within a and block. ## Dependency Property Information @@ -743,7 +743,7 @@ , the changes must be done within a and block. + When you make property changes to a , the changes must be done within a and block. ## Dependency Property Information @@ -795,7 +795,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Media.Imaging/CroppedBitmap.xml b/xml/System.Windows.Media.Imaging/CroppedBitmap.xml index 98b2faaa306..7a45e8fa2c1 100644 --- a/xml/System.Windows.Media.Imaging/CroppedBitmap.xml +++ b/xml/System.Windows.Media.Imaging/CroppedBitmap.xml @@ -32,9 +32,9 @@ implements the interface to optimize initialization on multiple properties. Property changes can occur only during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. + implements the interface to optimize initialization on multiple properties. Property changes can occur only during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. - objects created by using the constructor are automatically initialized, and properties cannot be changed. + objects created by using the constructor are automatically initialized, and properties cannot be changed. Metadata tags related to image data must be updated if an image is saved to a file after a transform is applied. @@ -80,7 +80,7 @@ implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. + implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. ]]> @@ -123,7 +123,7 @@ ## Examples - The following example shows how to use to initialize a new instance of the class. + The following example shows how to use to initialize a new instance of the class. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapImage/Overview/CroppedImageExample.xaml.cs" id="Snippetcroppedcsharp2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Imaging/BitmapImage/Overview/CroppedImageExample.xaml.vb" id="Snippetcroppedcsharp2"::: @@ -169,12 +169,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/CroppedBitmapExample.cs" id="Snippetcroppedbitmapcodeexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/CroppedBitmapExample.vb" id="Snippetcroppedbitmapcodeexamplewholepage"::: @@ -222,7 +222,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -293,7 +293,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -400,12 +400,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/CroppedBitmapExample.cs" id="Snippetcroppedbitmapcodeexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/CroppedBitmapExample.vb" id="Snippetcroppedbitmapcodeexamplewholepage"::: @@ -587,7 +587,7 @@ with a set to will render the entire image. + A with a set to will render the entire image. A rectangle that is not fully within the bounds of the bitmap will not render. diff --git a/xml/System.Windows.Media.Imaging/FormatConvertedBitmap.xml b/xml/System.Windows.Media.Imaging/FormatConvertedBitmap.xml index efef9a281a0..3e8b46ecbf2 100644 --- a/xml/System.Windows.Media.Imaging/FormatConvertedBitmap.xml +++ b/xml/System.Windows.Media.Imaging/FormatConvertedBitmap.xml @@ -32,11 +32,11 @@ implements the interface to optimize initialization on multiple properties. Property changes can occur only during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. + implements the interface to optimize initialization on multiple properties. Property changes can occur only during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. - objects created using the constructor are automatically initialized, and property changes are ignored. + objects created using the constructor are automatically initialized, and property changes are ignored. - For format conversions between RGB color spaces with different characteristics, the class should be used. Conversions between color spaces need a source color profile and destination color profile for gamut mapping to provide a reliable color conversion. The color profiles are provided by the parameters of the or by the and properties. + For format conversions between RGB color spaces with different characteristics, the class should be used. Conversions between color spaces need a source color profile and destination color profile for gamut mapping to provide a reliable color conversion. The color profiles are provided by the parameters of the or by the and properties. Metadata tags related to image data must be updated if an image is saved to a file after a transform is applied. @@ -82,7 +82,7 @@ implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. + implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. ]]> @@ -162,7 +162,7 @@ value is used to determine what level of opacity will be mapped to the fully transparent color in the converted format. A value of 9.8 implies that any pixel with an alpha value of less than 25 will be mapped to the transparent color. A value of 100 maps all pixels which are not fully opaque to the transparent color. + The value is used to determine what level of opacity will be mapped to the fully transparent color in the converted format. A value of 9.8 implies that any pixel with an alpha value of less than 25 will be mapped to the transparent color. A value of 100 maps all pixels which are not fully opaque to the transparent color. The destination palette should provide a transparent color; otherwise, the transparent color will be the one closest to zero, often black. @@ -239,12 +239,12 @@ and calls. After the has been initialized, property changes are ignored. + Property initialization must be done between and calls. After the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/FormatConvertedBitmapExample.cs" id="Snippetformatconvertedbitmapcodeexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/FormatConvertedBitmapExample.vb" id="Snippetformatconvertedbitmapcodeexamplewholepage"::: @@ -293,7 +293,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -364,7 +364,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -535,7 +535,7 @@ . + You must set this property if you want to use an indexed pixel format for the . ## Dependency Property Information @@ -617,12 +617,12 @@ and calls, as demonstrated in the following example. After the has been initialized, property changes are ignored. + Property initialization must be done between and calls, as demonstrated in the following example. After the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/FormatConvertedBitmapExample.cs" id="Snippetformatconvertedbitmapcodeexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/FormatConvertedBitmapExample.vb" id="Snippetformatconvertedbitmapcodeexamplewholepage"::: diff --git a/xml/System.Windows.Media.Imaging/InPlaceBitmapMetadataWriter.xml b/xml/System.Windows.Media.Imaging/InPlaceBitmapMetadataWriter.xml index 54b8164532a..b893f39e3a8 100644 --- a/xml/System.Windows.Media.Imaging/InPlaceBitmapMetadataWriter.xml +++ b/xml/System.Windows.Media.Imaging/InPlaceBitmapMetadataWriter.xml @@ -24,24 +24,24 @@ Enables in-place updates to existing blocks of . - is not associated with a that is obtained through a , the attempt to write metadata by using the in-place writer will fail. Successful write operations apply the metadata directly to the image stream by means of a decoder. - - In-place metadata updates fail if an attempt is made to write metadata that a given bitmap format does not support. - - To perform in-place metadata edits, the bitmap must be decoded using either the or cache options. does not guarantee access to the metadata stream needed for in-place metadata edits. - - - -## Examples - This example shows how you can modify metadata within an image without having to re-encode the image. The following example uses an to write metadata into an image. - + is not associated with a that is obtained through a , the attempt to write metadata by using the in-place writer will fail. Successful write operations apply the metadata directly to the image stream by means of a decoder. + + In-place metadata updates fail if an attempt is made to write metadata that a given bitmap format does not support. + + To perform in-place metadata edits, the bitmap must be decoded using either the or cache options. does not guarantee access to the metadata stream needed for in-place metadata edits. + + + +## Examples + This example shows how you can modify metadata within an image without having to re-encode the image. The following example uses an to write metadata into an image. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: + ]]> @@ -76,13 +76,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -280,15 +280,15 @@ if bitmap metadata can be written successfully; otherwise, . - method to determine whether metadata can be written successfully to a Tagged Image File Format (TIFF) image. - + method to determine whether metadata can be written successfully to a Tagged Image File Format (TIFF) image. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/BitMapMetadata/CPP/BitmapMetadata.cpp" id="Snippetsetquery"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapDecoder/CreateInPlaceBitmapMetadataWriter/BitmapMetadata.cs" id="Snippetsetquery"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitMapMetadata/VB/BitmapMetadata.vb" id="Snippetsetquery"::: + ]]> diff --git a/xml/System.Windows.Media.Imaging/JpegBitmapDecoder.xml b/xml/System.Windows.Media.Imaging/JpegBitmapDecoder.xml index 2cf3d167d0c..1dfe0aa8195 100644 --- a/xml/System.Windows.Media.Imaging/JpegBitmapDecoder.xml +++ b/xml/System.Windows.Media.Imaging/JpegBitmapDecoder.xml @@ -24,16 +24,16 @@ Defines a decoder for Joint Photographics Experts Group (JPEG) encoded images. - that are supported by the class. - -|Supplied PixelFormat|Decodes to PixelFormat| -|--------------------------|----------------------------| -||| -||| - + that are supported by the class. + +|Supplied PixelFormat|Decodes to PixelFormat| +|--------------------------|----------------------------| +||| +||| + ]]> @@ -85,20 +85,20 @@ The cache method to use for the bitmap image. Initializes a new instance of the class from the specified file stream, with the specified and . - cache option if you wish to close the `bitmapStream` after the decoder is created. The default cache option retains access to the stream until the bitmap is needed and cleanup is handled by the garbage collector. - - - -## Examples - The following code example demonstrates how to create an instance of and use a from a file stream. The decoded image is used as the source of an control. - + cache option if you wish to close the `bitmapStream` after the decoder is created. The default cache option retains access to the stream until the bitmap is needed and cleanup is handled by the garbage collector. + + + +## Examples + The following code example demonstrates how to create an instance of and use a from a file stream. The decoded image is used as the source of an control. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/CPP/jpegencoderdecoder.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/JpegBitmapDecoder/.ctor/JpegEncoderDecoder.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/VB/JpegEncoderDecoder.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/VB/JpegEncoderDecoder.vb" id="Snippet1"::: + ]]> The value is . @@ -142,20 +142,20 @@ The cache method to use for the bitmap image. Initializes a new instance of the class from the specified , with the specified and . - from a . The decoded image is used as the source of an control. - + from a . The decoded image is used as the source of an control. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/CPP/jpegencoderdecoder.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/JpegBitmapDecoder/.ctor/JpegEncoderDecoder.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/VB/JpegEncoderDecoder.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/JpegBitmapDecoderEncoder/VB/JpegEncoderDecoder.vb" id="Snippet5"::: + ]]> The value is . diff --git a/xml/System.Windows.Media.Imaging/LateBoundBitmapDecoder.xml b/xml/System.Windows.Media.Imaging/LateBoundBitmapDecoder.xml index 96c4376f2aa..4d8b52682ba 100644 --- a/xml/System.Windows.Media.Imaging/LateBoundBitmapDecoder.xml +++ b/xml/System.Windows.Media.Imaging/LateBoundBitmapDecoder.xml @@ -181,7 +181,7 @@ is downloaded asynchronously, it is possible for the underlying collection of to change after content is downloaded and decoded. While content is downloading, the collection always returns at least one item. When downloading and decoding are complete, the automatically changes its underlying content. In other words, only the collection object can change; the actual frame object remains the same. + Because a is downloaded asynchronously, it is possible for the underlying collection of to change after content is downloaded and decoded. While content is downloading, the collection always returns at least one item. When downloading and decoding are complete, the automatically changes its underlying content. In other words, only the collection object can change; the actual frame object remains the same. Any frame obtained from a while the image is downloading will return a width/height of `1,1` until the frames have finished downloading. diff --git a/xml/System.Windows.Media.Imaging/TiffBitmapEncoder.xml b/xml/System.Windows.Media.Imaging/TiffBitmapEncoder.xml index 85e28304be1..83fed347f39 100644 --- a/xml/System.Windows.Media.Imaging/TiffBitmapEncoder.xml +++ b/xml/System.Windows.Media.Imaging/TiffBitmapEncoder.xml @@ -119,7 +119,7 @@ , , and values require that the value be set to . + The , , and values require that the value be set to . ## Examples The following example demonstrates how to use the property. diff --git a/xml/System.Windows.Media.Imaging/TiffCompressOption.xml b/xml/System.Windows.Media.Imaging/TiffCompressOption.xml index 2d071663997..310644c35d4 100644 --- a/xml/System.Windows.Media.Imaging/TiffCompressOption.xml +++ b/xml/System.Windows.Media.Imaging/TiffCompressOption.xml @@ -26,7 +26,7 @@ value be set to . Setting the to any other value resets the property value to Default. + The Ccitt3, Ccitt4, and Rle require that the value be set to . Setting the to any other value resets the property value to Default. diff --git a/xml/System.Windows.Media.Imaging/TransformedBitmap.xml b/xml/System.Windows.Media.Imaging/TransformedBitmap.xml index 3ef701a788b..c50e56edf84 100644 --- a/xml/System.Windows.Media.Imaging/TransformedBitmap.xml +++ b/xml/System.Windows.Media.Imaging/TransformedBitmap.xml @@ -34,9 +34,9 @@ ## Remarks supports only orthogonal transforms such as rotation transforms of 90° increments and scale transforms. Transforms that skew the image are not supported. - implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. + implements the interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call to signal that initialization has begun and to signal that initialization has completed. After initialization, property changes are ignored. - objects created using the constructor are automatically initialized and property changes are ignored. + objects created using the constructor are automatically initialized and property changes are ignored. Metadata tags related to image data must be updated if an image is saved to a file after a transform is applied. @@ -80,7 +80,7 @@ implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. + implements the interface to optimize initialization on multiple properties. To initialize a created using this constructor, you must perform property initialization between and calls. ]]> @@ -163,12 +163,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/TransformedBitmapExample.cs" id="Snippettransformedbitmappropinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/TransformedBitmapExample.vb" id="Snippettransformedbitmappropinit"::: @@ -217,7 +217,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -288,7 +288,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -395,12 +395,12 @@ and calls. Once the has been initialized, property changes are ignored. + Property initialization must be done between and calls. Once the has been initialized, property changes are ignored. ## Examples - The following example demonstrates how to initialize a with a set of properties by using the and methods. + The following example demonstrates how to initialize a with a set of properties by using the and methods. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/TransformedBitmapExample.cs" id="Snippettransformedbitmappropinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PixelFormat/Overview/TransformedBitmapExample.vb" id="Snippettransformedbitmappropinit"::: @@ -599,7 +599,7 @@ ## Examples - The following example shows how to apply a to a bitmap. + The following example shows how to apply a to a bitmap. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Imaging/BitmapImage/Overview/TransformedImageExample.xaml" id="Snippettransformedxaml2"::: diff --git a/xml/System.Windows.Media.Imaging/WmpBitmapEncoder.xml b/xml/System.Windows.Media.Imaging/WmpBitmapEncoder.xml index f1f19ecccd0..211401ce23b 100644 --- a/xml/System.Windows.Media.Imaging/WmpBitmapEncoder.xml +++ b/xml/System.Windows.Media.Imaging/WmpBitmapEncoder.xml @@ -145,7 +145,7 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is set to `true` and the image contains either a planar or interleaved alpha channel; otherwise, it is ignored. + This property has an effect only if is set to `true` and the image contains either a planar or interleaved alpha channel; otherwise, it is ignored. ]]> @@ -188,7 +188,7 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is `false`. + This property has an effect only if is `false`. ]]> @@ -370,11 +370,11 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is `true`, must be set to 0. + If is `true`, must be set to 0. A tile created by the division can never be smaller than 16 pixels. The value is adjusted to maintain the minimum tile size. - When used in combination with , a grid of tiles is formed. For example, if both properties are set to 1, the image is divided into 4 tiles. + When used in combination with , a grid of tiles is formed. For example, if both properties are set to 1, the image is divided into 4 tiles. ]]> @@ -421,7 +421,7 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is `true` and a subregion encode is requested. + This value is valid only when is `true` and a subregion encode is requested. ]]> @@ -485,7 +485,7 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is set to `true`; otherwise, it is ignored. + This property has an effect only if is set to `true`; otherwise, it is ignored. ]]> @@ -830,9 +830,9 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is `true`, , , and are used in place of the . + When is `true`, , , and are used in place of the . - When is `false`, , , and are set based on . + When is `false`, , , and are set based on . ]]> @@ -874,11 +874,11 @@ Windows Media Photo or HD Photo is a codec that provides better image fidelity t is `true`, must be set to 0. + If is `true`, must be set to 0. A tile created by the division can never be smaller than 16 pixels. The value is adjusted to maintain the minimum tile size. - When used in combination with , a grid of tiles is formed. For example, if both properties are set to 1, the image is divided into 4 tiles. + When used in combination with , a grid of tiles is formed. For example, if both properties are set to 1, the image is divided into 4 tiles. ]]> diff --git a/xml/System.Windows.Media.Imaging/WriteableBitmap.xml b/xml/System.Windows.Media.Imaging/WriteableBitmap.xml index deb9be8516e..7039796a394 100644 --- a/xml/System.Windows.Media.Imaging/WriteableBitmap.xml +++ b/xml/System.Windows.Media.Imaging/WriteableBitmap.xml @@ -35,19 +35,19 @@ The UI thread writes content to the back buffer. The render thread reads content from the front buffer and copies it to video memory. Changes to the back buffer are tracked with changed rectangular regions. - Call one of the overloads to update and display content in the back buffer automatically. + Call one of the overloads to update and display content in the back buffer automatically. For greater control over updates, and for multi-threaded access to the back buffer, use the following workflow. -1. Call the method to reserve the back buffer for updates. +1. Call the method to reserve the back buffer for updates. 2. Obtain a pointer to the back buffer by accessing the property. 3. Write changes to the back buffer. Other threads may write changes to the back buffer when the is locked. -4. Call the method to indicate areas that have changed. +4. Call the method to indicate areas that have changed. -5. Call the method to release the back buffer and allow presentation to the screen. +5. Call the method to release the back buffer and allow presentation to the screen. When updates are sent to the rendering thread, the rendering thread copies the changed rectangles from the back buffer to the front buffer. The rendering system controls this exchange to avoid deadlocks and redraw artifacts, such as "tearing". @@ -108,7 +108,7 @@ constructor is preferred over using this constructor. + The constructor is preferred over using this constructor. If `source` does not use a natively supported bitmap format, format conversions are applied for each frame update, which reduces performance. @@ -162,7 +162,7 @@ and . These formats are natively supported and do not require a format conversion. Other `pixelFormat` values require a format conversion for each frame update, which reduces performance. + The preferred values for `pixelFormat` are and . These formats are natively supported and do not require a format conversion. Other `pixelFormat` values require a format conversion for each frame update, which reduces performance. ]]> @@ -207,16 +207,16 @@ method to indicate changes your code has made to the back buffer. + Call the method to indicate changes your code has made to the back buffer. When you call this method multiple times, the changed areas are accumulated in a sufficient, but not necessarily minimal, representation. For efficiency, only the areas that are marked as dirty are guaranteed to be copied forward to the front buffer. However, any portion of the bitmap may be copied forward, so you must ensure that the entire back buffer is always valid. - Call the method only between calls to the and methods, as described in the class remarks. + Call the method only between calls to the and methods, as described in the class remarks. ## Examples - The following code example shows how to specify the area of the back buffer that changed by using the method. + The following code example shows how to specify the area of the back buffer that changed by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/WriteableBitmap/Overview/Program.cs" id="Snippet2"::: @@ -269,12 +269,12 @@ ## Remarks The back buffer contains the bitmap contents in the pixel format requested by the user. - Update the back buffer only between calls to the and methods. If you do not follow the Lock/Unlock workflow described in the class remarks, undefined behaviors, such as tearing, can occur. + Update the back buffer only between calls to the and methods. If you do not follow the Lock/Unlock workflow described in the class remarks, undefined behaviors, such as tearing, can occur. The address of the back buffer does not change. ## Thread Safety - You can pass the pointer to external components and other threads for processing, but if you do, you must provide you own thread coordination. In particular, you must ensure that the UI thread specifies changed areas by calling the method, and that the UI thread unlocks the buffer by calling the method. + You can pass the pointer to external components and other threads for processing, but if you do, you must provide you own thread coordination. In particular, you must ensure that the UI thread specifies changed areas by calling the method, and that the UI thread unlocks the buffer by calling the method. ]]> @@ -342,7 +342,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -423,7 +423,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -658,16 +658,16 @@ method increments the lock count. When a is locked, the rendering system does not send updates until the is fully unlocked by calls to the method. + The method increments the lock count. When a is locked, the rendering system does not send updates until the is fully unlocked by calls to the method. - You can use the method to support multi-threaded implementations. In these scenarios, the UI thread locks the bitmap and exposes the back buffer to other threads. When the worker thread has finished a frame, the UI thread adds changed rectangles and unlocks the buffer. + You can use the method to support multi-threaded implementations. In these scenarios, the UI thread locks the bitmap and exposes the back buffer to other threads. When the worker thread has finished a frame, the UI thread adds changed rectangles and unlocks the buffer. - The UI thread can block when the render thread acquires a lock on the back buffer to copy it forward to the front buffer. If the latency from this block is too long, use the method to wait for a short time and then unblock the UI thread to perform other tasks while the back buffer is locked. + The UI thread can block when the render thread acquires a lock on the back buffer to copy it forward to the front buffer. If the latency from this block is too long, use the method to wait for a short time and then unblock the UI thread to perform other tasks while the back buffer is locked. ## Examples - The following code example shows how to reserve the back buffer by using the method. + The following code example shows how to reserve the back buffer by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/WriteableBitmap/Overview/Program.cs" id="Snippet2"::: @@ -718,7 +718,7 @@ method is the same as the method. + When a lock is acquired, the behavior of the method is the same as the method. ]]> @@ -764,12 +764,12 @@ method decrements the lock count. When the lock count reaches 0, a render pass is requested if the method has been called. + The method decrements the lock count. When the lock count reaches 0, a render pass is requested if the method has been called. ## Examples - The following code example shows how to release the back buffer by using the method. + The following code example shows how to release the back buffer by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/WriteableBitmap/Overview/Program.cs" id="Snippet2"::: @@ -834,15 +834,15 @@ and overloads are preferred over using this method. + The and overloads are preferred over using this method. > [!NOTE] -> In partial trust, use the overload. +> In partial trust, use the overload. ## Examples - The following code example shows how to update a pixel in the back buffer by using the method. + The following code example shows how to update a pixel in the back buffer by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/WriteableBitmap/Overview/Program.cs" id="Snippet3"::: @@ -906,10 +906,10 @@ and overloads are preferred over using this method. + The and overloads are preferred over using this method. > [!NOTE] -> In partial trust, use the overload. +> In partial trust, use the overload. ]]> @@ -971,7 +971,7 @@ method to update the automatically with the contents of `sourceBuffer`. Calling this method is the equivalent of using the and workflow described in the class remarks. + Call the method to update the automatically with the contents of `sourceBuffer`. Calling this method is the equivalent of using the and workflow described in the class remarks. > [!NOTE] > Use this overload in partial trust. @@ -1041,10 +1041,10 @@ method to update the automatically with the contents of `sourceBuffer`. Calling this method is the equivalent of using the and workflow described in the class remarks. + Call the method to update the automatically with the contents of `sourceBuffer`. Calling this method is the equivalent of using the and workflow described in the class remarks. > [!NOTE] -> In partial trust, use the overload. +> In partial trust, use the overload. ]]> diff --git a/xml/System.Windows.Media.Media3D/AffineTransform3D.xml b/xml/System.Windows.Media.Media3D/AffineTransform3D.xml index 3e34984bd44..c14e750e6c3 100644 --- a/xml/System.Windows.Media.Media3D/AffineTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/AffineTransform3D.xml @@ -54,13 +54,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -93,13 +93,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media.Media3D/AmbientLight.xml b/xml/System.Windows.Media.Media3D/AmbientLight.xml index 6dbbbcde063..76face87f68 100644 --- a/xml/System.Windows.Media.Media3D/AmbientLight.xml +++ b/xml/System.Windows.Media.Media3D/AmbientLight.xml @@ -159,7 +159,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -198,7 +198,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/AxisAngleRotation3D.xml b/xml/System.Windows.Media.Media3D/AxisAngleRotation3D.xml index 1031c6bcf5d..34feef65c0b 100644 --- a/xml/System.Windows.Media.Media3D/AxisAngleRotation3D.xml +++ b/xml/System.Windows.Media.Media3D/AxisAngleRotation3D.xml @@ -327,7 +327,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -366,7 +366,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Camera.xml b/xml/System.Windows.Media.Media3D/Camera.xml index 69c3cd1ed52..589cf8c9c6f 100644 --- a/xml/System.Windows.Media.Media3D/Camera.xml +++ b/xml/System.Windows.Media.Media3D/Camera.xml @@ -79,7 +79,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -118,7 +118,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/ContainerUIElement3D.xml b/xml/System.Windows.Media.Media3D/ContainerUIElement3D.xml index 83f0a6545ce..b0b8d1f81e2 100644 --- a/xml/System.Windows.Media.Media3D/ContainerUIElement3D.xml +++ b/xml/System.Windows.Media.Media3D/ContainerUIElement3D.xml @@ -33,7 +33,7 @@ collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. + The collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. does not have a visual representation; it serves as a container for other visual 3-D objects. is a object, which provides support for input, focus, and events in 3-D. @@ -83,7 +83,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -125,9 +125,9 @@ collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. + The collection of a element can only consist of objects. Adding a child to a implicitly adds it to the for the element. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Media.Media3D/DiffuseMaterial.xml b/xml/System.Windows.Media.Media3D/DiffuseMaterial.xml index ae4fcec63f0..79acf35cab4 100644 --- a/xml/System.Windows.Media.Media3D/DiffuseMaterial.xml +++ b/xml/System.Windows.Media.Media3D/DiffuseMaterial.xml @@ -263,7 +263,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -302,7 +302,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/DirectionalLight.xml b/xml/System.Windows.Media.Media3D/DirectionalLight.xml index 0f6eca6cf42..f08b8345191 100644 --- a/xml/System.Windows.Media.Media3D/DirectionalLight.xml +++ b/xml/System.Windows.Media.Media3D/DirectionalLight.xml @@ -162,7 +162,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -201,7 +201,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/EmissiveMaterial.xml b/xml/System.Windows.Media.Media3D/EmissiveMaterial.xml index a61b109be22..bdf641f6f97 100644 --- a/xml/System.Windows.Media.Media3D/EmissiveMaterial.xml +++ b/xml/System.Windows.Media.Media3D/EmissiveMaterial.xml @@ -208,7 +208,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -247,7 +247,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -332,7 +332,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform2DTo3D.xml b/xml/System.Windows.Media.Media3D/GeneralTransform2DTo3D.xml index aad2286a07e..8546f61de7d 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform2DTo3D.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform2DTo3D.xml @@ -24,13 +24,13 @@ Provides 2-D to 3-D transformation support. - method returns a object. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method returns a object. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -68,11 +68,11 @@ The object to clone. Makes the instance a clone (deep copy) of the specified using base (non-animated) property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -108,11 +108,11 @@ The to be cloned. Makes the instance a modifiable clone (deep copy) of the specified using current property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -146,11 +146,11 @@ Creates a new instance of the derived class. The new instance. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -186,11 +186,11 @@ The instance to copy. Makes the instance a frozen clone of the specified using base (non-animated) property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -226,11 +226,11 @@ The to copy and freeze. Makes the current instance a frozen clone of the specified . If the object has animated dependency properties, their current animated values are copied. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -267,11 +267,11 @@ Transforms the specified point and returns the result. The result of transforming . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> The transform did not succeed. @@ -311,13 +311,13 @@ if was transformed; otherwise, . - method, this method does not throw an exception if the transformation is unsuccessful. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method, this method does not throw an exception if the transformation is unsuccessful. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform3D.xml b/xml/System.Windows.Media.Media3D/GeneralTransform3D.xml index 020cc2b9fbb..6f499804f4b 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform3D.xml @@ -34,13 +34,13 @@ Provides generalized transformation support for 3-D objects. - and methods, both of which return a object. In the case that the transformation between the 3-D objects may be represented by a 4x4 matrix, the methods return an instance of the class. The class can transform a to a and a to a . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + and methods, both of which return a object. In the case that the transformation between the 3-D objects may be represented by a 4x4 matrix, the methods return an instance of the class. The class can transform a to a and a to a . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -74,17 +74,17 @@ Creates a modifiable clone of this , making deep copies of this object's values. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - - When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + + When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -117,15 +117,15 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -157,11 +157,11 @@ Gets the inverse transformation of this , if possible. An inverse of this instance, if possible; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -197,26 +197,26 @@ - The format to use. - - -or- - + The format to use. + + -or- + A null reference ( in Visual Basic) to use the default format defined for the type of the implementation. - The provider to use to format the value. - - -or- - + The provider to use to format the value. + + -or- + A null reference ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. For a description of this member, see . The value of the current instance in the specified format. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -258,11 +258,11 @@ Creates a string representation of this instance. A string representation of this instance. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -299,11 +299,11 @@ Creates a string representation of this instance, based on the passed parameter. The value of the current instance in the specified format. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -339,11 +339,11 @@ Transforms the specified 3-D point and returns the result. The result of transforming . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> The transform did not succeed. @@ -380,11 +380,11 @@ When overridden in a derived class, transforms the specified 3-D bounding box and returns an axis-aligned 3-D bounding box that is exactly large enough to contain it. The smallest axis-aligned 3-D bounding box possible that contains the transformed . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -423,13 +423,13 @@ if was transformed; otherwise, . - method, this method does not throw an exception if the transformation is unsuccessful. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method, this method does not throw an exception if the transformation is unsuccessful. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection+Enumerator.xml b/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection+Enumerator.xml index ac572a6484d..77e5fd17234 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection+Enumerator.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection+Enumerator.xml @@ -36,11 +36,11 @@ Enumerates items in a . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -75,11 +75,11 @@ Gets the current element in the collection. The current element in the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -116,13 +116,13 @@ if the enumerator successfully advances to the next element; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -157,11 +157,11 @@ Resets the enumerator to its initial position, which is before the first element in the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -202,13 +202,13 @@ For a description of this member, see . To be added. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -243,13 +243,13 @@ For a description of this member, see . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection.xml b/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection.xml index 199dfb54933..e897ccd52cf 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform3DCollection.xml @@ -51,31 +51,31 @@ Represents an ordered collection of objects. - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreGeneralTransform3DObjectElements - - -``` - - -## XAML Values - *oneOrMoreGeneralTransform3DObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreGeneralTransform3DObjectElements + + +``` + + +## XAML Values + *oneOrMoreGeneralTransform3DObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -115,11 +115,11 @@ Initializes a new instance of the class. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -151,11 +151,11 @@ Initial object in the new collection class. Initializes a new instance of the class, using the specified initial object. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -189,11 +189,11 @@ The number of objects that the collection is initially capable of storing. Initializes a new instance of the class with the specified capacity, or the number of objects the collection is initially capable of storing. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -231,21 +231,21 @@ The to add to the end of the collection. Adds a object to the end of the collection. - , this implementation throws an if you attempt to add `null`. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + , this implementation throws an if you attempt to add `null`. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> is . - The collection is read-only. - + The collection is read-only. + -or- - + The collection has a fixed size. @@ -281,13 +281,13 @@ Removes all objects from the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> The collection is read-only. @@ -321,17 +321,17 @@ Creates a modifiable clone of this collection, making deep copies of this object's values. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - - When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + + When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -396,15 +396,15 @@ Creates a modifiable clone of this collection object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -476,11 +476,11 @@ if the collection contains ; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -521,11 +521,11 @@ The zero-based index position where copying begins. Copies the objects in the collection into an array of objects, starting at the specified index position. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -533,10 +533,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source collection is greater than the available space from to the end of the destination . @@ -572,11 +572,11 @@ Gets the number of objects in this collection. The number of items in the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -736,11 +736,11 @@ Returns an enumerator that can iterate through the collection. An enumerator that can iterate the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -780,11 +780,11 @@ Searches for the specified object within the collection. The zero-based index position of , or -1 if the object is not found in the collection. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -825,23 +825,23 @@ The object to insert. Inserts a object into the specified index position within the collection. - , this implementation throws an if you attempt to insert `null`. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + , this implementation throws an if you attempt to insert `null`. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> is . is not a valid index in the collection. - The collection is read-only. - + The collection is read-only. + -or- - + The collection has a fixed size. @@ -880,23 +880,23 @@ Gets or sets the object at the specified index position. The object at the position. - , this implementation throws an if you attempt to insert a `null` reference. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + , this implementation throws an if you attempt to insert a `null` reference. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> is . is not a valid index in the collection. - The collection is read-only. - + The collection is read-only. + -or- - + The collection has a fixed size. @@ -935,17 +935,17 @@ if was successfully deleted; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> - The collection is read-only. - + The collection is read-only. + -or- - + The collection has a fixed size. @@ -984,11 +984,11 @@ The zero-based index position to remove the object. Deletes a object from the . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1025,13 +1025,13 @@ if the is read-only; otherwise, . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1067,13 +1067,13 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1113,13 +1113,13 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1155,13 +1155,13 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1196,13 +1196,13 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1238,13 +1238,13 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1283,13 +1283,13 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1329,13 +1329,13 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1374,13 +1374,13 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1420,13 +1420,13 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1462,13 +1462,13 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1504,13 +1504,13 @@ if the is read-only; otherwise, . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1555,13 +1555,13 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -1599,13 +1599,13 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + instance is cast to an interface. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform3DGroup.xml b/xml/System.Windows.Media.Media3D/GeneralTransform3DGroup.xml index 81cb402b175..0f7af2cc210 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform3DGroup.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform3DGroup.xml @@ -78,7 +78,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -114,7 +114,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ## Dependency Property Information @@ -196,11 +196,11 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -239,9 +239,9 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -309,7 +309,7 @@ ## Remarks The inverse of a is created by combining the inverses of its child transforms. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -349,7 +349,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -392,7 +392,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Media.Media3D/GeneralTransform3DTo2D.xml b/xml/System.Windows.Media.Media3D/GeneralTransform3DTo2D.xml index 830da51f43e..27e46e1a03b 100644 --- a/xml/System.Windows.Media.Media3D/GeneralTransform3DTo2D.xml +++ b/xml/System.Windows.Media.Media3D/GeneralTransform3DTo2D.xml @@ -24,13 +24,13 @@ Provides 3-D to 2-D transformation support. - to a and a to a . The method returns a object. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + to a and a to a . The method returns a object. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -68,11 +68,11 @@ The object to clone. Makes the instance a clone (deep copy) of the specified using base (non-animated) property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -108,11 +108,11 @@ The to be cloned. Makes the instance a modifiable clone (deep copy) of the specified using current property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -146,11 +146,11 @@ Creates a new instance of the derived class. The new instance. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -186,11 +186,11 @@ The instance to copy. Makes the instance a frozen clone of the specified using base (non-animated) property values. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -226,11 +226,11 @@ The to copy and freeze. Makes the current instance a frozen clone of the specified . If the object has animated dependency properties, their current animated values are copied. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -267,11 +267,11 @@ Transforms the specified 3-D point and returns the result. The result of transforming . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> The transform did not succeed. @@ -308,11 +308,11 @@ Transforms the specified 3-D bounding box and returns an axis-aligned bounding box that contains all of the points in the original 3-D bounding box. An axis-aligned bounding box that contains all of the points in the specified 3-D bounding box. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -351,13 +351,13 @@ if was transformed; otherwise, . - method, this method does not throw an exception if the transformation is unsuccessful. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method, this method does not throw an exception if the transformation is unsuccessful. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media.Media3D/Geometry3D.xml b/xml/System.Windows.Media.Media3D/Geometry3D.xml index 015a576da3e..ecc82d8fee0 100644 --- a/xml/System.Windows.Media.Media3D/Geometry3D.xml +++ b/xml/System.Windows.Media.Media3D/Geometry3D.xml @@ -31,20 +31,20 @@ Classes that derive from this abstract base class define 3D geometric shapes. The class of objects can be used for hit-testing and rendering 3D graphic data. - by itself has no appearance. To render a , use a to combine the with a . - - is the concrete instance of a . To render a 3D shape, compose a by specifying a MeshGeometry3D and a Material. - - - -## Examples - The following example illustrates how a is combined with a using a . - - :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/Basic3D/XAML/Window1.xaml" id="Snippetbasic3dxaml3dn3"::: - + by itself has no appearance. To render a , use a to combine the with a . + + is the concrete instance of a . To render a 3D shape, compose a by specifying a MeshGeometry3D and a Material. + + + +## Examples + The following example illustrates how a is combined with a using a . + + :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/Basic3D/XAML/Window1.xaml" id="Snippetbasic3dxaml3dn3"::: + ]]> @@ -106,13 +106,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -145,13 +145,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media.Media3D/GeometryModel3D.xml b/xml/System.Windows.Media.Media3D/GeometryModel3D.xml index afda7745cf2..ab6cd0de65a 100644 --- a/xml/System.Windows.Media.Media3D/GeometryModel3D.xml +++ b/xml/System.Windows.Media.Media3D/GeometryModel3D.xml @@ -32,7 +32,7 @@ The front and back sides of the are determined by the winding order of the triangles in the . The front side winds counter clockwise. - The and properties may be or `null`. When the material is transparent, you cannot see that side of the triangle, but hit testing works as usual. When the material is `null`, you cannot see it, and hit testing does not work. + The and properties may be or `null`. When the material is transparent, you cannot see that side of the triangle, but hit testing works as usual. When the material is `null`, you cannot see it, and hit testing does not work. @@ -41,7 +41,7 @@ :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/Basic3D/XAML/Window1.xaml" id="Snippetbasic3dxaml3dn3"::: - The following code excerpt uses a whose is defined as a static resource. + The following code excerpt uses a whose is defined as a static resource. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Media3D/AxisAngleRotation3D/Overview/Window11.xaml" id="Snippetanimate3drotation3dn1"::: @@ -171,7 +171,7 @@ is `null`. + The back side of a mesh is determined by the triangle winding order. Ordinarily, back faces are not rendered unless the object is transformed or animated. Back faces are never rendered when is `null`. ## Dependency Property Information @@ -246,7 +246,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -285,7 +285,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -368,7 +368,7 @@ :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/Basic3D/XAML/Window1.xaml" id="Snippetbasic3dxaml3dn3"::: - The following code excerpt uses a whose is defined as a static resource. + The following code excerpt uses a whose is defined as a static resource. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Media3D/AxisAngleRotation3D/Overview/Window11.xaml" id="Snippetanimate3drotation3dn1"::: diff --git a/xml/System.Windows.Media.Media3D/Light.xml b/xml/System.Windows.Media.Media3D/Light.xml index bc2692dbc2e..0006ed44b2f 100644 --- a/xml/System.Windows.Media.Media3D/Light.xml +++ b/xml/System.Windows.Media.Media3D/Light.xml @@ -77,7 +77,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -116,7 +116,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Material.xml b/xml/System.Windows.Media.Media3D/Material.xml index 6009c236a47..b80e3df4073 100644 --- a/xml/System.Windows.Media.Media3D/Material.xml +++ b/xml/System.Windows.Media.Media3D/Material.xml @@ -35,11 +35,11 @@ Abstract base class for materials. - @@ -72,13 +72,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -111,13 +111,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -153,15 +153,15 @@ - The format to use. - - -or- - + The format to use. + + -or- + A null reference ( in Visual Basic) to use the default format defined for the type of the implementation. - The provider to use to format the value. - - -or- - + The provider to use to format the value. + + -or- + A null reference ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. Formats the value of the current instance using the specified format. The value of the current instance in the specified format. diff --git a/xml/System.Windows.Media.Media3D/MaterialCollection.xml b/xml/System.Windows.Media.Media3D/MaterialCollection.xml index 9bb3508ce4c..348e7e809d7 100644 --- a/xml/System.Windows.Media.Media3D/MaterialCollection.xml +++ b/xml/System.Windows.Media.Media3D/MaterialCollection.xml @@ -268,7 +268,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -642,9 +642,9 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. + Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. - Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. + Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first item of the collection again, you can call Reset followed by MoveNext. @@ -872,7 +872,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -912,7 +912,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media.Media3D/Matrix3D.xml b/xml/System.Windows.Media.Media3D/Matrix3D.xml index 7d414fc7382..e48d06d0ad6 100644 --- a/xml/System.Windows.Media.Media3D/Matrix3D.xml +++ b/xml/System.Windows.Media.Media3D/Matrix3D.xml @@ -50,10 +50,10 @@ | Column 1 | Column 2 | Column 3 | Column 4 | |----------|----------|----------|----------| -||||| -||||| -||||| -||||| +||||| +||||| +||||| +||||| Note that because the fourth column is also accessible, the matrix allows developers to represent affine as well as non-affine transforms. diff --git a/xml/System.Windows.Media.Media3D/MatrixCamera.xml b/xml/System.Windows.Media.Media3D/MatrixCamera.xml index 405238060bd..5bca3e49bb3 100644 --- a/xml/System.Windows.Media.Media3D/MatrixCamera.xml +++ b/xml/System.Windows.Media.Media3D/MatrixCamera.xml @@ -37,7 +37,7 @@ ## Examples - The following code creates a and sets the and properties. + The following code creates a and sets the and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/MatrixCamera/Overview/Window1.xaml.cs" id="Snippetmatrixtransform3dview3dn11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/MatrixCamera/Overview/window1.xaml.vb" id="Snippetmatrixtransform3dview3dn11"::: @@ -164,7 +164,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -283,7 +283,7 @@ ## Examples - The following code creates a and sets the and properties. + The following code creates a and sets the and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/MatrixCamera/Overview/Window1.xaml.cs" id="Snippetmatrixtransform3dview3dn11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/MatrixCamera/Overview/window1.xaml.vb" id="Snippetmatrixtransform3dview3dn11"::: @@ -365,7 +365,7 @@ ## Examples - The following code creates a and sets the and properties. + The following code creates a and sets the and properties. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/MatrixCamera/Overview/Window1.xaml.cs" id="Snippetmatrixtransform3dview3dn11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/MatrixCamera/Overview/window1.xaml.vb" id="Snippetmatrixtransform3dview3dn11"::: diff --git a/xml/System.Windows.Media.Media3D/MatrixTransform3D.xml b/xml/System.Windows.Media.Media3D/MatrixTransform3D.xml index 25e3bea960c..870d83999ed 100644 --- a/xml/System.Windows.Media.Media3D/MatrixTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/MatrixTransform3D.xml @@ -138,7 +138,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects or of any object. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -177,7 +177,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects or of any object. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -356,7 +356,7 @@ property inherits from the class. The property enables you to convert any object into a object. Because the class is defined by using a Matrix3D, the and properties always return the same value. The MatrixTransform3D class exposes the property to enable write access. + The property inherits from the class. The property enables you to convert any object into a object. Because the class is defined by using a Matrix3D, the and properties always return the same value. The MatrixTransform3D class exposes the property to enable write access. diff --git a/xml/System.Windows.Media.Media3D/MeshGeometry3D.xml b/xml/System.Windows.Media.Media3D/MeshGeometry3D.xml index f1c06f83e99..815757c25bd 100644 --- a/xml/System.Windows.Media.Media3D/MeshGeometry3D.xml +++ b/xml/System.Windows.Media.Media3D/MeshGeometry3D.xml @@ -136,7 +136,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -175,7 +175,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Model3D.xml b/xml/System.Windows.Media.Media3D/Model3D.xml index 75d72613fee..d45975ebf9a 100644 --- a/xml/System.Windows.Media.Media3D/Model3D.xml +++ b/xml/System.Windows.Media.Media3D/Model3D.xml @@ -114,7 +114,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects or of any object. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -153,7 +153,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects or of any object. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Model3DCollection.xml b/xml/System.Windows.Media.Media3D/Model3DCollection.xml index e1aa30bbece..123556da470 100644 --- a/xml/System.Windows.Media.Media3D/Model3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/Model3DCollection.xml @@ -257,7 +257,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -328,7 +328,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -633,9 +633,9 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. + Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. - Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. + Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first item of the collection again, you can call Reset followed by MoveNext. @@ -863,7 +863,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -903,7 +903,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media.Media3D/Model3DGroup.xml b/xml/System.Windows.Media.Media3D/Model3DGroup.xml index 3449f0b5e98..e5d6eb02184 100644 --- a/xml/System.Windows.Media.Media3D/Model3DGroup.xml +++ b/xml/System.Windows.Media.Media3D/Model3DGroup.xml @@ -169,7 +169,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -208,7 +208,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/ModelUIElement3D.xml b/xml/System.Windows.Media.Media3D/ModelUIElement3D.xml index 92a772fb756..f1f18780ca7 100644 --- a/xml/System.Windows.Media.Media3D/ModelUIElement3D.xml +++ b/xml/System.Windows.Media.Media3D/ModelUIElement3D.xml @@ -74,7 +74,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Media.Media3D/ModelVisual3D.xml b/xml/System.Windows.Media.Media3D/ModelVisual3D.xml index 15b50153051..a145a2dc814 100644 --- a/xml/System.Windows.Media.Media3D/ModelVisual3D.xml +++ b/xml/System.Windows.Media.Media3D/ModelVisual3D.xml @@ -231,7 +231,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -428,7 +428,7 @@ is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Media.Media3D/OrthographicCamera.xml b/xml/System.Windows.Media.Media3D/OrthographicCamera.xml index e7ecc98d6a7..6cc35d7d9d8 100644 --- a/xml/System.Windows.Media.Media3D/OrthographicCamera.xml +++ b/xml/System.Windows.Media.Media3D/OrthographicCamera.xml @@ -168,7 +168,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -207,7 +207,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/PerspectiveCamera.xml b/xml/System.Windows.Media.Media3D/PerspectiveCamera.xml index a65a0d734d9..95449f03d3b 100644 --- a/xml/System.Windows.Media.Media3D/PerspectiveCamera.xml +++ b/xml/System.Windows.Media.Media3D/PerspectiveCamera.xml @@ -158,7 +158,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -197,7 +197,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Point3D.xml b/xml/System.Windows.Media.Media3D/Point3D.xml index 280cd9e3345..68a1e2646e4 100644 --- a/xml/System.Windows.Media.Media3D/Point3D.xml +++ b/xml/System.Windows.Media.Media3D/Point3D.xml @@ -73,9 +73,9 @@ ## Examples - This example shows how to subtract structures and structures using the overloaded subtraction (`-`) operator and the static method. + This example shows how to subtract structures and structures using the overloaded subtraction (`-`) operator and the static method. - The following code illustrates how to use the subtraction methods. First, the structures and the structures are instantiated. The structures are subtracted using the overloaded subtraction (`-`) operator and then they are subtracted using the static method. Next, the structure is subtracted from the first structure using the static method, and finally the structure is subtract from the using the overloaded subtraction (`-`) operator. + The following code illustrates how to use the subtraction methods. First, the structures and the structures are instantiated. The structures are subtracted using the overloaded subtraction (`-`) operator and then they are subtracted using the static method. Next, the structure is subtracted from the first structure using the static method, and finally the structure is subtract from the using the overloaded subtraction (`-`) operator. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsubtract3dpointsexample_csharp"::: @@ -315,7 +315,7 @@ structures are equal if the values of their , , and properties are the same. + Two structures are equal if the values of their , , and properties are the same. Because values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. @@ -445,9 +445,9 @@ structure to a structure with the corresponding , , and values. + This operation is equivalent to adding a structure to a structure with the corresponding , , and values. - Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. @@ -549,7 +549,7 @@ structures are equal if the values of their , , and properties are the same. + Two structures are equal if the values of their , , and properties are the same. Because values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. @@ -678,7 +678,7 @@ structures are not equal if the values of their , , and properties are different. + Two structures are not equal if the values of their , , and properties are different. Because values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. diff --git a/xml/System.Windows.Media.Media3D/Point3DCollection.xml b/xml/System.Windows.Media.Media3D/Point3DCollection.xml index e13585e2e66..435e2936568 100644 --- a/xml/System.Windows.Media.Media3D/Point3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/Point3DCollection.xml @@ -299,7 +299,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -370,7 +370,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -642,9 +642,9 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. + Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. - Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. + Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first item of the collection again, you can call Reset followed by MoveNext. @@ -905,7 +905,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -945,7 +945,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media.Media3D/Point4D.xml b/xml/System.Windows.Media.Media3D/Point4D.xml index bd1944a5a85..fdefcfba39e 100644 --- a/xml/System.Windows.Media.Media3D/Point4D.xml +++ b/xml/System.Windows.Media.Media3D/Point4D.xml @@ -62,16 +62,16 @@ ## XAML Values *x* - The component of this structure. + The component of this structure. *y* - The component of this structure. + The component of this structure. *z* - The component of this structure. + The component of this structure. *w* - The component of this structure. + The component of this structure. ]]> @@ -306,7 +306,7 @@ structures are equal if the values of their , , , and properties are the same. + Two structures are equal if the values of their , , , and properties are the same. Because values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. @@ -448,7 +448,7 @@ method will only have an effect if you can change the , , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the , , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. @@ -545,7 +545,7 @@ structures are equal if the values of their , , , and properties are the same. + Two structures are equal if the values of their , , , and properties are the same. Because a value can lose precision when arithmetic operations are performed on them, a comparison between two values that are logically equal might fail. @@ -599,7 +599,7 @@ structures are not equal if the values of their , , , and properties are different. + Two structures are not equal if the values of their , , , and properties are different. Because a value can lose precision when arithmetic operations are performed on them, a comparison between two values that are logically equal might fail. @@ -741,7 +741,7 @@ method to convert a string representation of point4D structure into a structure. + The following example shows how to use the method to convert a string representation of point4D structure into a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Point3D/GetHashCode/Window1.xaml.cs" id="Snippetmil4dpoints3dn13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Point3D/GetHashCode/window1.xaml.vb" id="Snippetmil4dpoints3dn13"::: diff --git a/xml/System.Windows.Media.Media3D/PointLight.xml b/xml/System.Windows.Media.Media3D/PointLight.xml index 598aca4ad2d..6b56c83752a 100644 --- a/xml/System.Windows.Media.Media3D/PointLight.xml +++ b/xml/System.Windows.Media.Media3D/PointLight.xml @@ -27,7 +27,7 @@ , , or properties. + The rate at which the light's intensity diminishes over distance is called its attenuation and can be controlled by setting the , , or properties. @@ -154,7 +154,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -193,7 +193,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/PointLightBase.xml b/xml/System.Windows.Media.Media3D/PointLightBase.xml index 73cd783079a..cd712aabb07 100644 --- a/xml/System.Windows.Media.Media3D/PointLightBase.xml +++ b/xml/System.Windows.Media.Media3D/PointLightBase.xml @@ -67,7 +67,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -106,7 +106,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/ProjectionCamera.xml b/xml/System.Windows.Media.Media3D/ProjectionCamera.xml index 0147555f94e..c82e8d76686 100644 --- a/xml/System.Windows.Media.Media3D/ProjectionCamera.xml +++ b/xml/System.Windows.Media.Media3D/ProjectionCamera.xml @@ -62,7 +62,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -101,7 +101,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -360,7 +360,7 @@ on which the camera's projection is centered. + Note that this property returns the location of the camera, not the on which the camera's projection is centered. ## Dependency Property Information diff --git a/xml/System.Windows.Media.Media3D/Quaternion.xml b/xml/System.Windows.Media.Media3D/Quaternion.xml index e5106910d03..66300d0e339 100644 --- a/xml/System.Windows.Media.Media3D/Quaternion.xml +++ b/xml/System.Windows.Media.Media3D/Quaternion.xml @@ -64,16 +64,16 @@ ## XAML Values *x* - The component of this structure. + The component of this structure. *y* - The component of this structure. + The component of this structure. *z* - The component of this structure. + The component of this structure. *w* - The component of this structure. + The component of this structure. diff --git a/xml/System.Windows.Media.Media3D/QuaternionRotation3D.xml b/xml/System.Windows.Media.Media3D/QuaternionRotation3D.xml index 39763709a78..a9b558dea79 100644 --- a/xml/System.Windows.Media.Media3D/QuaternionRotation3D.xml +++ b/xml/System.Windows.Media.Media3D/QuaternionRotation3D.xml @@ -149,7 +149,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -188,7 +188,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/RayMeshGeometry3DHitTestResult.xml b/xml/System.Windows.Media.Media3D/RayMeshGeometry3DHitTestResult.xml index 24e6a3dbd94..6773cc0926d 100644 --- a/xml/System.Windows.Media.Media3D/RayMeshGeometry3DHitTestResult.xml +++ b/xml/System.Windows.Media.Media3D/RayMeshGeometry3DHitTestResult.xml @@ -24,13 +24,13 @@ Represents an intersection between a ray hit test and a . - . - - Barycentric coordinates returned by , , and can be interpolated to find the where the intersection occurred, or the point on the intersected model's texture using texture coordinates. - + . + + Barycentric coordinates returned by , , and can be interpolated to find the where the intersection occurred, or the point on the intersected model's texture using texture coordinates. + ]]> @@ -68,14 +68,14 @@ Gets the distance between the point of intersection and the ray's origin in the coordinate space of which initiated the hit test. Double that indicates the distance between the point of intersection and the ray's origin in the coordinate space of which initiated the hit test. - @@ -184,11 +184,11 @@ First vertex of the mesh triangle intersected by the ray. The index of the first vertex. - , , and collections of the mesh triangle intersected. - + , , and collections of the mesh triangle intersected. + ]]> @@ -226,11 +226,11 @@ Second vertex of the mesh triangle intersected by the ray. The index of the second vertex. - , , and collections of the mesh triangle intersected. - + , , and collections of the mesh triangle intersected. + ]]> @@ -268,11 +268,11 @@ Third vertex of the mesh triangle intersected by the ray. The index of the third vertex. - , , and collections of the mesh triangle intersected. - + , , and collections of the mesh triangle intersected. + ]]> @@ -304,11 +304,11 @@ Relative contribution of the first vertex of a mesh triangle to the point at which that triangle was intersected by the hit test, expressed as a value between zero and 1. The weighting of the first vertex. - @@ -340,11 +340,11 @@ Relative contribution of the second vertex of a mesh triangle to the point at which that triangle was intersected by the hit test, expressed as a value between zero and 1. The weighting of the second vertex. - @@ -376,11 +376,11 @@ Relative contribution of the third vertex of a mesh triangle to the point at which that triangle was intersected by the hit test, expressed as a value between zero and 1. The weighting of the third vertex. - diff --git a/xml/System.Windows.Media.Media3D/Rect3D.xml b/xml/System.Windows.Media.Media3D/Rect3D.xml index 162ad83b803..815389d4887 100644 --- a/xml/System.Windows.Media.Media3D/Rect3D.xml +++ b/xml/System.Windows.Media.Media3D/Rect3D.xml @@ -46,7 +46,7 @@ is defined as a location () and a size structure (). Because the , , and values specified for the size are magnitudes and not coordinates, they cannot be negative except in the case of an empty rectangle. An empty rectangle is specified by , which has , , and values of -Infinity. + is defined as a location () and a size structure (). Because the , , and values specified for the size are magnitudes and not coordinates, they cannot be negative except in the case of an empty rectangle. An empty rectangle is specified by , which has , , and values of -Infinity. This structure is typically used to represent the bounds of a or . @@ -676,7 +676,7 @@ is zero, this still contains a zero- or 1-dimensional set of points; therefore, this property should not be used to check for zero area. + If is zero, this still contains a zero- or 1-dimensional set of points; therefore, this property should not be used to check for zero area. is typically used to represent the bounds of a or . @@ -770,7 +770,7 @@ ## Remarks is typically used to represent the bounds of a or . - Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. ]]> @@ -859,7 +859,7 @@ ## Remarks is typically used to represent the bounds of a or . - Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the , , and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change , , or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. ]]> diff --git a/xml/System.Windows.Media.Media3D/RotateTransform3D.xml b/xml/System.Windows.Media.Media3D/RotateTransform3D.xml index 08f710bb866..af56d05f610 100644 --- a/xml/System.Windows.Media.Media3D/RotateTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/RotateTransform3D.xml @@ -30,7 +30,7 @@ ## Remarks Rotations in 2-D usually consist of two arguments: a point around which to rotate an object or set of objects, and a value in degrees or radians that determines the amount of rotation. In 3-D, it is necessary to specify a rather than a point around which to rotate. - Rotations in 3-D become more complicated when they are animated. To animate a 3-D rotation using , you can animate the or properties of an , or specify a for the transform. + Rotations in 3-D become more complicated when they are animated. To animate a 3-D rotation using , you can animate the or properties of an , or specify a for the transform. Axis/angle rotations in Windows Presentation Foundation (WPF) 3-D are specified in degrees, not radians. @@ -441,7 +441,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -480,7 +480,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Rotation3D.xml b/xml/System.Windows.Media.Media3D/Rotation3D.xml index e266c2d5d35..ef8c54da16c 100644 --- a/xml/System.Windows.Media.Media3D/Rotation3D.xml +++ b/xml/System.Windows.Media.Media3D/Rotation3D.xml @@ -60,13 +60,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -99,13 +99,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -176,15 +176,15 @@ - The format to use. - - -or- - + The format to use. + + -or- + A null reference ( in Visual Basic) to use the default format defined for the type of the implementation. - The provider to use to format the value. - - -or- - + The provider to use to format the value. + + -or- + A null reference ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. Formats the value of the current instance using the specified format. The value of the current instance in the specified format. diff --git a/xml/System.Windows.Media.Media3D/ScaleTransform3D.xml b/xml/System.Windows.Media.Media3D/ScaleTransform3D.xml index 1de50d773ee..ced10141529 100644 --- a/xml/System.Windows.Media.Media3D/ScaleTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/ScaleTransform3D.xml @@ -455,7 +455,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -494,7 +494,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Size3D.xml b/xml/System.Windows.Media.Media3D/Size3D.xml index a4fdc7203f3..29308de9390 100644 --- a/xml/System.Windows.Media.Media3D/Size3D.xml +++ b/xml/System.Windows.Media.Media3D/Size3D.xml @@ -43,18 +43,18 @@ Data structure that describes the size of a three-dimensional object. - and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. - -## Examples - This example shows how to determine if two structures are equal using the static method. - - The following code illustrates how to check structures for equality. The structures are declared and assigned values. The method is then used to determine if the two structures are equal. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: - + and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. + +## Examples + This example shows how to determine if two structures are equal using the static method. + + The following code illustrates how to check structures for equality. The structures are declared and assigned values. The method is then used to determine if the two structures are equal. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: + ]]> @@ -90,11 +90,11 @@ The new structure's value. Initializes a new instance of the structure. - , , and values must be non-negative. - + , , and values must be non-negative. + ]]> @@ -132,19 +132,19 @@ Gets a value that represents an empty structure. An empty instance of a structure. - structure with , , and values set to 0 is not empty. An empty structure has , , and values set to negative infinity. This is the only time a structure can have negative values. - - - -## Examples - The following example shows how to make a structure empty. - + structure with , , and values set to 0 is not empty. An empty structure has , , and values set to negative infinity. This is the only time a structure can have negative values. + + + +## Examples + The following example shows how to make a structure empty. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn10"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn10"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn10"::: + ]]> @@ -188,23 +188,23 @@ The to compare. Determines whether the specified object is a structure and whether the , and properties of the specified are equal to the , and properties of this structure. - if instances are equal; otherwise, . - + if instances are equal; otherwise, . + if is a structure and is identical with this structure; otherwise, . - values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. - - - -## Examples - The following example shows how to check if an and a structure are equal. - + values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. + + + +## Examples + The following example shows how to check if an and a structure are equal. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn3"::: + ]]> @@ -242,11 +242,11 @@ if instances are equal; otherwise, . - values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. - + values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. + ]]> @@ -284,22 +284,22 @@ The second structure to compare. Compares two structures for equality. Two structures are equal if the values of their , , and properties are the same. - if instances are equal; otherwise, . - + if instances are equal; otherwise, . + if the , , and components of and are equal; otherwise, . - values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. - - - -## Examples - The following example shows how to check if two structures are equal. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: - + values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. + + + +## Examples + The following example shows how to check if two structures are equal. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: + ]]> @@ -333,14 +333,14 @@ Returns a hash code for this structure. A hash code for this structure. - structure. - + structure. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn12"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn12"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn12"::: + ]]> @@ -373,19 +373,19 @@ if the structure is empty; otherwise, . The default is . - structure with , , and values set to 0 is not empty. An empty structure has , , and values set to negative infinity. This is the only time a structure can have negative values. - - - -## Examples - The following example shows how to check if a structure is empty. - + structure with , , and values set to 0 is not empty. An empty structure has , , and values set to negative infinity. This is the only time a structure can have negative values. + + + +## Examples + The following example shows how to check if a structure is empty. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn9"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn9"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn9"::: + ]]> @@ -425,19 +425,19 @@ if the , , and components of and are equal; otherwise, . - values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. - - - -## Examples - The following example shows how to use the overloaded equality operator to check if two structures are equal. - + values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. + + + +## Examples + The following example shows how to use the overloaded equality operator to check if two structures are equal. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn4"::: + ]]> @@ -483,14 +483,14 @@ Converts this structure into a structure. The result of converting . - structure into a structure. - + structure into a structure. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn8"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn8"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn8"::: + ]]> @@ -526,14 +526,14 @@ Converts this structure into a structure. The result of converting . - structure into a structure. - + structure into a structure. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn7"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn7"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn7"::: + ]]> @@ -572,19 +572,19 @@ if the , and coordinates of and are different; otherwise, . - values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. - - - -## Examples - The following example shows how to use the overloaded inequality operator to check if two structures are not equal. - + values can lose precision when arithmetic operations are performed on them, a comparison between two instances that are logically equal might fail. + + + +## Examples + The following example shows how to use the overloaded inequality operator to check if two structures are not equal. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn5"::: + ]]> @@ -620,14 +620,14 @@ Converts a representation of a three-dimensional size structure into the equivalent structure. The equivalent structure. - into a structure. - + into a structure. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn6"::: + ]]> @@ -669,15 +669,15 @@ - The string specifying the format to use. - - -or- - + The string specifying the format to use. + + -or- + to use the default format defined for the type of the implementation. - The to use to format the value. - - -or- - + The to use to format the value. + + -or- + to obtain the numeric format information from the current locale setting of the operating system. This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. For a description of this member, see . A string containing the value of the current instance in the specified format. @@ -727,19 +727,19 @@ Creates a representation of this structure. Returns a containing the , , and values of this structure. - structure is empty, the string "empty" is returned, rather than the , , and values of the structure. - - - -## Examples - The following example shows how to get a string representation of a structure. - + structure is empty, the string "empty" is returned, rather than the , , and values of the structure. + + + +## Examples + The following example shows how to get a string representation of a structure. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn11"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn11"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn11"::: + ]]> @@ -781,11 +781,11 @@ Creates a representation of this structure. Returns a containing the , , and values of this structure. - structure is empty, the string "empty" is returned, rather than the , , and values of the structure. - + structure is empty, the string "empty" is returned, rather than the , , and values of the structure. + ]]> @@ -823,19 +823,19 @@ Gets or sets the value of this structure. The value of this structure. The default value is 0. - , , and values must be non-negative. - - and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. - -## Examples - The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. - + , , and values must be non-negative. + + and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. + +## Examples + The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Size3D/Empty/Window1.xaml.cs" id="Snippetmil3dsize3dn2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Size3D/Empty/window1.xaml.vb" id="Snippetmil3dsize3dn2"::: + ]]> @@ -873,18 +873,18 @@ Gets or sets the value of this structure. The value of this structure. The default value is 0. - , , and values must be non-negative. - - and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. - -## Examples - The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: - + , , and values must be non-negative. + + and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. + +## Examples + The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: + ]]> @@ -922,18 +922,18 @@ Gets or sets the value of this structure. The value of this structure. The default value is 0. - , , and values must be non-negative. - - and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. - -## Examples - The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: - + , , and values must be non-negative. + + and are not typically used in XAML, because no settable properties exist in the WPF 3D object model that use those types. + +## Examples + The following example shows how to check if two structures are equal. It also shows how to assign values to a structure when the structure is being declared and after the structure has been declared. + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsize3dequalityexample_csharp"::: + ]]> diff --git a/xml/System.Windows.Media.Media3D/SpecularMaterial.xml b/xml/System.Windows.Media.Media3D/SpecularMaterial.xml index 3b817f18a2d..27b79087b38 100644 --- a/xml/System.Windows.Media.Media3D/SpecularMaterial.xml +++ b/xml/System.Windows.Media.Media3D/SpecularMaterial.xml @@ -238,7 +238,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -277,7 +277,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -361,7 +361,7 @@ dependency property. + The identifier for the dependency property. ]]> diff --git a/xml/System.Windows.Media.Media3D/SpotLight.xml b/xml/System.Windows.Media.Media3D/SpotLight.xml index 07e74f5ebfe..aa86353d8bb 100644 --- a/xml/System.Windows.Media.Media3D/SpotLight.xml +++ b/xml/System.Windows.Media.Media3D/SpotLight.xml @@ -30,7 +30,7 @@ ## Remarks is a kind of , since it has a position, range, and attenuation. However, also allows you to control the direction, shape, and other properties of the cone of the light's effect. - Specify values for (beyond which nothing is illuminated), and (within which everything is fully illuminated) to change the spotlighting effect. + Specify values for (beyond which nothing is illuminated), and (within which everything is fully illuminated) to change the spotlighting effect. Lighting between the outside of the inner cone and the outer cone falls off linearly. @@ -155,7 +155,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -194,7 +194,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -343,7 +343,7 @@ 's illumination diminishes from full illumination to none in that angle of the light's projection between the and the . + The intensity of the 's illumination diminishes from full illumination to none in that angle of the light's projection between the and the . ![Spotlight diagram](~/add/media/spotlight-1.png "Spotlight diagram") @@ -428,7 +428,7 @@ 's illumination diminishes from full illumination to none in that angle of the light's projection between the and the . The light provides no illumination outside the angle specified by this property. + The intensity of the 's illumination diminishes from full illumination to none in that angle of the light's projection between the and the . The light provides no illumination outside the angle specified by this property. ![Spotlight diagram](~/add/media/spotlight-1.png "Spotlight diagram") diff --git a/xml/System.Windows.Media.Media3D/Transform3D.xml b/xml/System.Windows.Media.Media3D/Transform3D.xml index 86166a50df2..eaa8ff0e004 100644 --- a/xml/System.Windows.Media.Media3D/Transform3D.xml +++ b/xml/System.Windows.Media.Media3D/Transform3D.xml @@ -31,11 +31,11 @@ Provides a parent class for all three-dimensional transformations, including translation, rotation, and scale transformations. - class to create transformations not available from the , , and classes. - + class to create transformations not available from the , , and classes. + ]]> @@ -68,15 +68,15 @@ Creates a modifiable clone of this , making deep copies of this object's values. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - - When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + + When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. + ]]> @@ -109,13 +109,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property is even if the source's property is . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -147,11 +147,11 @@ Gets the identity transformation. Identity transformation. - @@ -183,11 +183,11 @@ Gets the inverse transformation of this object, if possible. An inverse of this instance, if possible; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -220,11 +220,11 @@ if the matrix is affine; otherwise, . - @@ -464,11 +464,11 @@ Transforms the specified 3-D bounding box and returns an axis-aligned 3-D bounding box that is exactly large enough to contain it. The smallest axis-aligned 3-D bounding box possible that contains the transformed . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -507,13 +507,13 @@ if was transformed; otherwise, . - method, this method does not throw an exception if the transformation is unsuccessful. - - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method, this method does not throw an exception if the transformation is unsuccessful. + + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -545,12 +545,12 @@ Gets the that represents the value of the current transformation. Matrix3D that represents the value of the current transformation. - diff --git a/xml/System.Windows.Media.Media3D/Transform3DCollection.xml b/xml/System.Windows.Media.Media3D/Transform3DCollection.xml index 4df93ea9a7a..4161d21c144 100644 --- a/xml/System.Windows.Media.Media3D/Transform3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/Transform3DCollection.xml @@ -258,7 +258,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -329,7 +329,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -634,9 +634,9 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. + Initially, the enumerator is positioned before the first item in the collection. also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. - Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. + Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first item of the collection again, you can call Reset followed by MoveNext. @@ -864,7 +864,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -904,7 +904,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media.Media3D/Transform3DGroup.xml b/xml/System.Windows.Media.Media3D/Transform3DGroup.xml index 80f64a3fb1d..c67843da76d 100644 --- a/xml/System.Windows.Media.Media3D/Transform3DGroup.xml +++ b/xml/System.Windows.Media.Media3D/Transform3DGroup.xml @@ -169,7 +169,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -208,7 +208,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/TranslateTransform3D.xml b/xml/System.Windows.Media.Media3D/TranslateTransform3D.xml index 900b18d75ff..8fe1e158b49 100644 --- a/xml/System.Windows.Media.Media3D/TranslateTransform3D.xml +++ b/xml/System.Windows.Media.Media3D/TranslateTransform3D.xml @@ -167,7 +167,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -206,7 +206,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media.Media3D/Vector3D.xml b/xml/System.Windows.Media.Media3D/Vector3D.xml index e1309b43039..07b7af9d562 100644 --- a/xml/System.Windows.Media.Media3D/Vector3D.xml +++ b/xml/System.Windows.Media.Media3D/Vector3D.xml @@ -59,20 +59,20 @@ ## XAML Values *x* - The component of this structure. + The component of this structure. *y* - The component of this structure. + The component of this structure. *z* - The component of this structure. + The component of this structure. ## Examples - This example shows how to subtract structures using the overloaded subtraction (`-`) operator and the static method. + This example shows how to subtract structures using the overloaded subtraction (`-`) operator and the static method. - The following code shows how to use the subtraction methods. First, the structures are instantiated. The structures are subtracted using the overloaded (`-`) operator, and then they are subtracted using the static method. + The following code shows how to use the subtraction methods. First, the structures are instantiated. The structures are subtracted using the overloaded (`-`) operator, and then they are subtracted using the static method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Viewport3D/.ctor/Misc3DOperationsExample.cs" id="Snippetsubtract3dvectorsexample_csharp"::: @@ -172,7 +172,7 @@ method to translate a structure by a structure. + The following example shows how to use the method to translate a structure by a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Matrix3D/Overview/Window1.xaml.cs" id="Snippetmil3dvectorsample3dn4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Matrix3D/Overview/window1.xaml.vb" id="Snippetmil3dvectorsample3dn4"::: @@ -552,7 +552,7 @@ structures are equal if the values of their , , and properties are the same. + Two structures are equal if the values of their , , and properties are the same. values are described using values. Because the value of a can lose precision when operated upon, a comparison between two values that are logically equal might fail. @@ -834,7 +834,7 @@ method to transform a structure by a structure. + The following example shows how to use the method to transform a structure by a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Matrix3D/Overview/Window1.xaml.cs" id="Snippetmil3dvectorsample3dn15"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Matrix3D/Overview/window1.xaml.vb" id="Snippetmil3dvectorsample3dn15"::: @@ -1117,7 +1117,7 @@ structures are equal if the values of their , , and properties are the same. + Two structures are equal if the values of their , , and properties are the same. values are described using values. Because the value of a can lose precision when operated upon, a comparison between two values that are logically equal might fail. @@ -1210,7 +1210,7 @@ structure cannot be negative, the absolute values of the , and properties of the structure are used. + Because a structure cannot be negative, the absolute values of the , and properties of the structure are used. ]]> @@ -1253,7 +1253,7 @@ structures are not equal if the values of their , , and properties are different. + Two structures are not equal if the values of their , , and properties are different. values are described using values. Because the value of a can lose precision when operated upon, a comparison between two values that are logically equal might fail. @@ -1551,7 +1551,7 @@ structure has the same magnitude () as `vector` but its direction is opposite of that of `vector`. + The returned structure has the same magnitude () as `vector` but its direction is opposite of that of `vector`. @@ -1600,7 +1600,7 @@ method to convert a string representation of a vector3D into a structure. + The following example shows how to use the method to convert a string representation of a vector3D into a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Media3D/Matrix3D/Overview/Window1.xaml.cs" id="Snippetmil3dvectorsample3dn28"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.Media3D/Matrix3D/Overview/window1.xaml.vb" id="Snippetmil3dvectorsample3dn28"::: diff --git a/xml/System.Windows.Media.Media3D/Vector3DCollection.xml b/xml/System.Windows.Media.Media3D/Vector3DCollection.xml index f7c5c243e27..f65a322e5a8 100644 --- a/xml/System.Windows.Media.Media3D/Vector3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/Vector3DCollection.xml @@ -295,7 +295,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -366,7 +366,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -638,9 +638,9 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. + Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of Current. - Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. + Current returns the same object until either MoveNext or is called. MoveNext sets Current to the next item. After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling MoveNext returns false. If the last call to MoveNext returned false, calling Current throws an exception. To set Current to the first item of the collection again, you can call Reset followed by MoveNext. @@ -901,7 +901,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -941,7 +941,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media.Media3D/Viewport2DVisual3D.xml b/xml/System.Windows.Media.Media3D/Viewport2DVisual3D.xml index 6a981a2488e..f3b4f243e8c 100644 --- a/xml/System.Windows.Media.Media3D/Viewport2DVisual3D.xml +++ b/xml/System.Windows.Media.Media3D/Viewport2DVisual3D.xml @@ -40,7 +40,7 @@ ## Examples - The following example shows how to place a button, a 2-D object, on a 3-D object. Note that you must set the attached property on the material on which you wish to have the 2-D visual placed. + The following example shows how to place a button, a 2-D object, on a 3-D object. Note that you must set the attached property on the material on which you wish to have the 2-D visual placed. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Media3D/Viewport2DVisual3D/Overview/window1.xaml" id="Snippetviewport3d"::: @@ -75,7 +75,7 @@ is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. ]]> @@ -114,7 +114,7 @@ The class projects 3-D content into 2-D to size the 2-D content in the 3-D element correctly. - Because caching always relies on the element's size, instead of the transform applied to it, when you set the property, initially your content may appear pixilated. This is because it is being upsampled to a much larger size than it was cached at. You can correct this situation by increasing the local size of your 2-D visual by setting the or properties. Also, you can increase the on the until the content reaches an acceptable level of clarity. + Because caching always relies on the element's size, instead of the transform applied to it, when you set the property, initially your content may appear pixilated. This is because it is being upsampled to a much larger size than it was cached at. You can correct this situation by increasing the local size of your 2-D visual by setting the or properties. Also, you can increase the on the until the content reaches an acceptable level of clarity. ]]> @@ -180,7 +180,7 @@ is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. @@ -263,7 +263,7 @@ is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. ]]> @@ -403,14 +403,14 @@ The following example shows how to specify the material where the 2-D visual (th attached property on the material on which you wish to have the 2-D visual placed. + You must set the attached property on the material on which you wish to have the 2-D visual placed. - is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. ## Examples - The following example shows how to specify the material where the 2-D visual (the button) should be placed by setting this property and also setting the attached property to `true`: + The following example shows how to specify the material where the 2-D visual (the button) should be placed by setting this property and also setting the attached property to `true`: :::code language="xaml" source="~/snippets/csharp/System.Windows.Media.Media3D/Viewport2DVisual3D/Overview/window1.xaml" id="Snippetviewport3d"::: @@ -489,7 +489,7 @@ The following example shows how to specify the material where the 2-D visual (th is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. ]]> @@ -527,7 +527,7 @@ The following example shows how to specify the material where the 2-D visual (th ## Remarks The visual is first applied to the , which is then used on the 3-D object. - is introduced in the .NET Framework version 3.5. + is introduced in the .NET Framework version 3.5. diff --git a/xml/System.Windows.Media.Media3D/Visual3D.xml b/xml/System.Windows.Media.Media3D/Visual3D.xml index 613a180cf34..1a38c5a1cde 100644 --- a/xml/System.Windows.Media.Media3D/Visual3D.xml +++ b/xml/System.Windows.Media.Media3D/Visual3D.xml @@ -75,7 +75,7 @@ method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -386,7 +386,7 @@ ## Remarks By default, a has no children. - The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -564,7 +564,7 @@ method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -603,7 +603,7 @@ method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -702,7 +702,7 @@ is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -742,7 +742,7 @@ method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -788,7 +788,7 @@ ## Remarks This transform projects a 3-D point to a 2-D space. The resulting point is the transformed 3-D point in the coordinate space of the specified ancestor. - The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -831,7 +831,7 @@ method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + The method is introduced in .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> diff --git a/xml/System.Windows.Media.Media3D/Visual3DCollection.xml b/xml/System.Windows.Media.Media3D/Visual3DCollection.xml index f40b1a308a6..6cf60bf7734 100644 --- a/xml/System.Windows.Media.Media3D/Visual3DCollection.xml +++ b/xml/System.Windows.Media.Media3D/Visual3DCollection.xml @@ -471,11 +471,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -511,11 +511,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -555,11 +555,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -595,11 +595,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -634,11 +634,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -674,11 +674,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -717,11 +717,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -761,11 +761,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -804,11 +804,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -848,11 +848,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -888,11 +888,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -928,11 +928,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -977,11 +977,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1019,11 +1019,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media.TextFormatting/CharacterBufferRange.xml b/xml/System.Windows.Media.TextFormatting/CharacterBufferRange.xml index 639985d3faf..f8ce05cc893 100644 --- a/xml/System.Windows.Media.TextFormatting/CharacterBufferRange.xml +++ b/xml/System.Windows.Media.TextFormatting/CharacterBufferRange.xml @@ -78,11 +78,11 @@ The number of characters in unsafecharacterString to use. Initializes a new instance of the structure from a unmanaged character string. - method. - + method. + ]]> @@ -258,11 +258,11 @@ if is equal to the current object; otherwise, . If is not a object, is returned. - objects are equal if the properties are equal. - + objects are equal if the properties are equal. + ]]> @@ -302,11 +302,11 @@ if is equal to the current object; otherwise, . If is not a object, is returned. - objects are equal if the properties are equal. - + objects are equal if the properties are equal. + ]]> diff --git a/xml/System.Windows.Media.TextFormatting/CharacterBufferReference.xml b/xml/System.Windows.Media.TextFormatting/CharacterBufferReference.xml index 36cde7e6114..69e041e2d2f 100644 --- a/xml/System.Windows.Media.TextFormatting/CharacterBufferReference.xml +++ b/xml/System.Windows.Media.TextFormatting/CharacterBufferReference.xml @@ -78,11 +78,11 @@ The length of . Initializes a new instance of the structure using a specified unsafe character string. - method. - + method. + ]]> diff --git a/xml/System.Windows.Media.TextFormatting/MinMaxParagraphWidth.xml b/xml/System.Windows.Media.TextFormatting/MinMaxParagraphWidth.xml index 39ac23ed802..449a284c3ae 100644 --- a/xml/System.Windows.Media.TextFormatting/MinMaxParagraphWidth.xml +++ b/xml/System.Windows.Media.TextFormatting/MinMaxParagraphWidth.xml @@ -310,7 +310,7 @@ and properties are equal. + The objects are equal if their and properties are equal. ]]> diff --git a/xml/System.Windows.Media.TextFormatting/TextFormatter.xml b/xml/System.Windows.Media.TextFormatting/TextFormatter.xml index 3b6db019144..97c6ee36681 100644 --- a/xml/System.Windows.Media.TextFormatting/TextFormatter.xml +++ b/xml/System.Windows.Media.TextFormatting/TextFormatter.xml @@ -63,7 +63,7 @@ Interaction between the text layout client and the TextFormatter object |Marker|Marker characteristics of the first line in the paragraph. See the property.| |Paragraph indentation|Indentation for the first line in the paragraph. See the property.| |Tabs|Includes support for tab alignment and tab leader.| -|Width|Determine minimum and maximum paragraph width. See the methods.| +|Width|Determine minimum and maximum paragraph width. See the methods.| |Word wrap|Determine how text wraps when it reaches the flow edge. See the property.| The following table is a list of the key supported services for line-level features. @@ -72,9 +72,9 @@ Interaction between the text layout client and the TextFormatter object |-------------|-----------------| |Alignment|Text alignment - left, right, centered, or justified. See the property.| |Line height|Height of the line. See the property.| -|Line collapsing|Line collapsing support. See the method.| +|Line collapsing|Line collapsing support. See the method.| |Black box measurement|Represents the metrics used to lay out a character in a device font. See the class.| -|Caret support|Caret navigation and editing support. See the character hit properties, such as and .| +|Caret support|Caret navigation and editing support. See the character hit properties, such as and .| The following table is a list of the key supported services for text run-level features. @@ -282,7 +282,7 @@ Interaction between the text layout client and the TextFormatter object method to return a formatted . + The following example shows how to use the method to return a formatted . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/Window1.xaml.cs" id="Snippettextformattingsnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/window1.xaml.vb" id="Snippettextformattingsnippet2"::: @@ -396,7 +396,7 @@ Minimum paragraph width ## Examples - The following example shows how to use the method to generate the minimum paragraph width for the formatted lines of text. + The following example shows how to use the method to generate the minimum paragraph width for the formatted lines of text. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/Window1.xaml.cs" id="Snippettextformattingsnippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/window1.xaml.vb" id="Snippettextformattingsnippet3"::: diff --git a/xml/System.Windows.Media.TextFormatting/TextLine.xml b/xml/System.Windows.Media.TextFormatting/TextLine.xml index ba3d0f70936..c4746c8604f 100644 --- a/xml/System.Windows.Media.TextFormatting/TextLine.xml +++ b/xml/System.Windows.Media.TextFormatting/TextLine.xml @@ -607,7 +607,7 @@ ## Remarks The return value is `null` when the line ends at the end of the paragraph. - The text formatter client may pass the return value back as a parameter to the method, which allows the value to be used when formatting the next line within the same paragraph. + The text formatter client may pass the return value back as a parameter to the method, which allows the value to be used when formatting the next line within the same paragraph. ]]> @@ -1088,7 +1088,7 @@ may differ from the property if the client specified the line height. + The may differ from the property if the client specified the line height. ]]> diff --git a/xml/System.Windows.Media.TextFormatting/TextLineBreak.xml b/xml/System.Windows.Media.TextFormatting/TextLineBreak.xml index 759bd0ebda4..3ca85220290 100644 --- a/xml/System.Windows.Media.TextFormatting/TextLineBreak.xml +++ b/xml/System.Windows.Media.TextFormatting/TextLineBreak.xml @@ -97,11 +97,11 @@ Releases the resources used by the class. - is called, the object is no longer valid. - + is called, the object is no longer valid. + ]]> diff --git a/xml/System.Windows.Media.TextFormatting/TextRun.xml b/xml/System.Windows.Media.TextFormatting/TextRun.xml index f976c0fe20c..e9b39f203e2 100644 --- a/xml/System.Windows.Media.TextFormatting/TextRun.xml +++ b/xml/System.Windows.Media.TextFormatting/TextRun.xml @@ -24,32 +24,32 @@ Represents a sequence of characters that share a single property set. - class is the root of a type hierarchy representing several types of text content processed by . Each class that is derived from represents a distinct type of text content. - -|Class|Description| -|-----------|-----------------| -||Root of the hierarchy. Defines a group of characters that share the same set of character properties.| -||Defines a collection of character glyphs from a distinct physical typeface.| -||Defines a type of text content in which measuring, hit testing, and drawing of the entire content is done as a distinct entity. An example of this type of content is a button in the middle of the line of text.| -||Defines a line-break character code.| -||Defines a paragraph-break character code. Derives from .| -||Defines a segment break marker.| -||Defines a range of non-visible characters.| -||Defines the beginning of a modification scope.| - - - -## Examples - In the following example, an override for the method is implemented. - + class is the root of a type hierarchy representing several types of text content processed by . Each class that is derived from represents a distinct type of text content. + +|Class|Description| +|-----------|-----------------| +||Root of the hierarchy. Defines a group of characters that share the same set of character properties.| +||Defines a collection of character glyphs from a distinct physical typeface.| +||Defines a type of text content in which measuring, hit testing, and drawing of the entire content is done as a distinct entity. An example of this type of content is a button in the middle of the line of text.| +||Defines a line-break character code.| +||Defines a paragraph-break character code. Derives from .| +||Defines a segment break marker.| +||Defines a range of non-visible characters.| +||Defines the beginning of a modification scope.| + + + +## Examples + In the following example, an override for the method is implemented. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/CustomTextClasses.cs" id="Snippettextformattingsnippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/customtextclasses.vb" id="Snippettextformattingsnippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/customtextclasses.vb" id="Snippettextformattingsnippet4"::: + ]]> Advanced Text Formatting Sample diff --git a/xml/System.Windows.Media.TextFormatting/TextRunTypographyProperties.xml b/xml/System.Windows.Media.TextFormatting/TextRunTypographyProperties.xml index d74cc26010e..ff531145de9 100644 --- a/xml/System.Windows.Media.TextFormatting/TextRunTypographyProperties.xml +++ b/xml/System.Windows.Media.TextFormatting/TextRunTypographyProperties.xml @@ -97,7 +97,7 @@ ## Remarks Annotation forms include glyphs placed in open or solid circles, squares, parentheses, diamonds, or rounded boxes. - If the value of is greater than 0 and the selected font does not support annotation alternates, the default form of the letter is displayed. + If the value of is greater than 0 and the selected font does not support annotation alternates, the default form of the letter is displayed. ]]> @@ -290,7 +290,7 @@ Example of random contextual alternates ## Remarks Contextual ligatures are designed to enhance readability by providing better joining behavior between the characters that make up the ligature. - If the value of is `true` and the selected font does not support contextual ligatures, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support contextual ligatures, the default form of the letter is displayed. ]]> @@ -667,7 +667,7 @@ Example of historical forms is `true` and the selected font does not support mathematical Greek forms, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support mathematical Greek forms, the default form of the letter is displayed. ]]> @@ -836,7 +836,7 @@ Example of standard and old-style numeral sets ![Text using OpenType slashed zero numerals](~/add/media/opentypefont17.gif "Text using OpenType slashed zero numerals") Example of slashed zero numerals - If the value of is `true` and the selected font does not support slashed zero forms, the default form of the numeral is displayed. + If the value of is `true` and the selected font does not support slashed zero forms, the default form of the numeral is displayed. ]]> @@ -890,7 +890,7 @@ Example of standard ligatures enabled by default ![Text using disabled OpenType standard ligatures](~/add/media/opentypefont07.gif "Text using disabled OpenType standard ligatures") Example of disabled standard ligatures - If the value of is `true` and the selected font does not support standard ligatures, the default form of the letter is displayed. + If the value of is `true` and the selected font does not support standard ligatures, the default form of the letter is displayed. ]]> @@ -939,7 +939,7 @@ Example of standard and swash glyphs ![Text using OpenType swashes](~/add/media/opentypefont09.gif "Text using OpenType swashes") Example of swashes used for capital letters - If the value of is greater than 0 and the selected font does not support standard swashes forms at the given index value, the default form of the letter is displayed. + If the value of is greater than 0 and the selected font does not support standard swashes forms at the given index value, the default form of the letter is displayed. ]]> diff --git a/xml/System.Windows.Media.TextFormatting/TextSource.xml b/xml/System.Windows.Media.TextFormatting/TextSource.xml index 073d00e1dac..184963c5d35 100644 --- a/xml/System.Windows.Media.TextFormatting/TextSource.xml +++ b/xml/System.Windows.Media.TextFormatting/TextSource.xml @@ -27,15 +27,15 @@ object is through the , which is designed to allow the text layout client to virtualize text in any way it chooses. + All access to the text in the object is through the , which is designed to allow the text layout client to virtualize text in any way it chooses. is the WPF text engine that provides services for formatting text and breaking text lines. can handle different text character formats and paragraph styles, and includes support for international text layout. Unlike a traditional text API, the interacts with a text layout client through a set of callback methods. It requires the client to provide these methods in an implementation of the class. The following list describes the three members you must override: -- : Retrieves a starting at a specified position. +- : Retrieves a starting at a specified position. -- : Retrieves the text span immediately before the specified position. +- : Retrieves the text span immediately before the specified position. -- : Retrieves a value that maps a character index to a character index. +- : Retrieves a value that maps a character index to a character index. > [!NOTE] > For a complete code sample that shows how to implement a derived class, see [Advanced Text Formatting Sample](https://go.microsoft.com/fwlink/?LinkID=159965) . @@ -111,7 +111,7 @@ method returns an empty if the text span immediately before `textSourceCharacterIndexLimit` does not contain any text, such as inline object or a hidden run. + The method returns an empty if the text span immediately before `textSourceCharacterIndexLimit` does not contain any text, such as inline object or a hidden run. This method returns a zero-length text span if there are no values preceding `textSourceCharacterIndexLimit`. @@ -202,7 +202,7 @@ ## Examples - In the following example, an override for the method is implemented. + In the following example, an override for the method is implemented. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/CustomTextClasses.cs" id="Snippettextformattingsnippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media.TextFormatting/MinMaxParagraphWidth/Overview/customtextclasses.vb" id="Snippettextformattingsnippet4"::: @@ -240,7 +240,7 @@ should update whenever the DPI changes for a Per Monitor DPI Aware application. + Any class that extends should update whenever the DPI changes for a Per Monitor DPI Aware application. ]]> diff --git a/xml/System.Windows.Media/ArcSegment.xml b/xml/System.Windows.Media/ArcSegment.xml index 2c73b89deee..3d6fbcec44d 100644 --- a/xml/System.Windows.Media/ArcSegment.xml +++ b/xml/System.Windows.Media/ArcSegment.xml @@ -32,7 +32,7 @@ An elliptical arc is defined by its start and end points, x- and y-radius, x-axis rotation factor, a value indicating whether the arc should be greater than 180 degrees, and a value describing the direction in which the arc is drawn. The class does not contain a property for the starting point of the arc; it only defines the destination point of the arc it represents. The beginning point of the arc is the current point of the to which the is added. - The following illustrations demonstrate the different end point, , and settings. + The following illustrations demonstrate the different end point, , and settings. ![ArcSegments with different Point settings](~/add/media/arcsegment-point.png "ArcSegments with different Point settings") @@ -41,11 +41,11 @@ ![ArcSegments with different RotationAngle settings](~/add/media/arcsegment-rotationangle.png "ArcSegments with different RotationAngle settings") ## IsLargeArc and SweepDirection - For most arcs of a particular position, size, and rotation, there are four different arcs that can be drawn; the and properties indicate which arc to use. + For most arcs of a particular position, size, and rotation, there are four different arcs that can be drawn; the and properties indicate which arc to use. - Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. + Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. - The following illustrations show different and settings. + The following illustrations show different and settings. ![ArcSegments with different IsLargeArc settings](~/add/media/arcsegment-islargearc.png "ArcSegments with different IsLargeArc settings") ArcSegment objects with different IsLargeArc settings @@ -213,7 +213,7 @@ ArcSegment objects with different SweepDirection settings ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -252,7 +252,7 @@ ArcSegment objects with different SweepDirection settings ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -319,11 +319,11 @@ ArcSegment objects with different SweepDirection settings and properties indicate which arc to use. + For most arcs of a particular position, size, and rotation, there are four different arcs that can be drawn; the and properties indicate which arc to use. - Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. + Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. - The following illustration shows two elliptical arcs that are identical except for their settings. + The following illustration shows two elliptical arcs that are identical except for their settings. ![ArcSegments with different IsLargeArc settings](~/add/media/arcsegment-islargearc.png "ArcSegments with different IsLargeArc settings") ArcSegment objects with different IsLargeArc settings @@ -402,11 +402,11 @@ ArcSegment objects with different IsLargeArc settings If the arc segment's start point and end point are the same, no arc is drawn. - For most arcs of a particular position, size, and rotation, there are four different arcs that can be drawn; the and properties indicate which arc to use. + For most arcs of a particular position, size, and rotation, there are four different arcs that can be drawn; the and properties indicate which arc to use. - Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. + Of the four candidate arc sweeps, two represent large arcs with sweeps of 180 degrees or greater, and two represent smaller arcs with sweeps 180 degrees or less. If is `true`, then one of the two larger arc sweeps is chosen; otherwise, if is `false`, one of the smaller arc sweeps is chosen. The remaining two arc candidates are each drawn in a different direction: or . The property specifies which one to use. - The following illustration shows several elliptical arcs that are identical except for their settings. + The following illustration shows several elliptical arcs that are identical except for their settings. ![ArcSegments with different Point settings](~/add/media/arcsegment-point.png "ArcSegments with different Point settings") Several ArcSegment objects with different Point settings @@ -481,7 +481,7 @@ Several ArcSegment objects with different Point settings settings. + The following illustration shows several elliptical arcs that are identical except for their settings. ![ArcSegments with different RotationAngle settings](~/add/media/arcsegment-rotationangle.png "ArcSegments with different RotationAngle settings") Several ArcSegment objects with different RotationAngle settings @@ -558,7 +558,7 @@ Several ArcSegment objects with different RotationAngle settings settings. + The following illustration shows several elliptical arcs that are identical except for their settings. ![ArcSegments with different Size settings](~/add/media/arcsegment-size.png "ArcSegments with different Size settings") Several ArcSegment objects with different Size settings @@ -633,9 +633,9 @@ Several ArcSegment objects with different Size settings with a given , , start point, and end , four different arcs are possible. Specifying the property reduces the number of possible arcs to two: an arc drawn from the start point to the end in a direction and an arc drawn from the start point to the end point in a direction. + For an with a given , , start point, and end , four different arcs are possible. Specifying the property reduces the number of possible arcs to two: an arc drawn from the start point to the end in a direction and an arc drawn from the start point to the end point in a direction. - The following illustration shows two elliptical arcs that are identical except for their settings. + The following illustration shows two elliptical arcs that are identical except for their settings. ![ArcSegments with different SweepDirection settings](~/add/media/arcsegment-sweepdirection.png "ArcSegments with different SweepDirection settings") ArcSegment objects with different SweepDirection settings diff --git a/xml/System.Windows.Media/BezierSegment.xml b/xml/System.Windows.Media/BezierSegment.xml index afdfd1f021d..4eadb44b982 100644 --- a/xml/System.Windows.Media/BezierSegment.xml +++ b/xml/System.Windows.Media/BezierSegment.xml @@ -30,9 +30,9 @@ ## Remarks Use a object to store objects and other segments. - A cubic Bezier curve is defined by four points: a start point, an end point (), and two control points ( and ). The class does not contain a property for the starting point of the curve; it only defines the end point. The beginning point of the curve is the current point of the to which the is added. + A cubic Bezier curve is defined by four points: a start point, an end point (), and two control points ( and ). The class does not contain a property for the starting point of the curve; it only defines the end point. The beginning point of the curve is the current point of the to which the is added. - The two control points of a cubic Bezier curve behave like magnets, attracting portions of what would otherwise be a straight line toward themselves and producing a curve. The first control point, , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. + The two control points of a cubic Bezier curve behave like magnets, attracting portions of what would otherwise be a straight line toward themselves and producing a curve. The first control point, , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. ## Freezable Features A is a type of object. For information about features, such as freezing and cloning, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -170,7 +170,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -209,7 +209,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -275,7 +275,7 @@ , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. + The two control points of a cubic Bezier curve behave like magnets, attracting portions of what would otherwise be a straight line toward themselves and producing a curve. The first control point, , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. ## Dependency Property Information @@ -347,7 +347,7 @@ , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. + The two control points of a cubic Bezier curve behave like magnets, attracting portions of what would otherwise be a straight line toward themselves and producing a curve. The first control point, , affects the beginning portion of the curve; the second control point, , affects the ending portion of the curve. Note that the curve doesn't necessarily pass through either of the control points; each control point moves its portion of the line toward itself, but not through itself. ## Dependency Property Information diff --git a/xml/System.Windows.Media/BitmapCache.xml b/xml/System.Windows.Media/BitmapCache.xml index ddb22cf0171..dc64eeef432 100644 --- a/xml/System.Windows.Media/BitmapCache.xml +++ b/xml/System.Windows.Media/BitmapCache.xml @@ -37,7 +37,7 @@ Caching a control does not affect mouse-over behavior, so mouse-over hit testing operates as if it the bitmap were a live control. - Cache regeneration occurs only when the structure of the or its subtree changes, or when the settings change. Setting the or properties causes cache regeneration. Changes to the parent visual tree of the cached , such as transforms, scales, opacities, and effects, do not affect the cache. + Cache regeneration occurs only when the structure of the or its subtree changes, or when the settings change. Setting the or properties causes cache regeneration. Changes to the parent visual tree of the cached , such as transforms, scales, opacities, and effects, do not affect the cache. The cache functions when hardware acceleration is not available. In this case, the bitmap is rendered in software, and the maximum bitmap dimensions are 2048 x 2048. @@ -318,9 +318,9 @@ ## Remarks Use the property to render the at a multiple of the normal bitmap size. The normal size is determined by the local size of the element. - Values greater than 1 increase the resolution of the bitmap relative to the native resolution of the element, and values less than 1 decrease the resolution. For example, if the property is set to 2.0, and you apply a scale transform that enlarges the content by a factor of 2, the content will have the same visual quality as the same content with set to 1.0 and a transform scale of 1. + Values greater than 1 increase the resolution of the bitmap relative to the native resolution of the element, and values less than 1 decrease the resolution. For example, if the property is set to 2.0, and you apply a scale transform that enlarges the content by a factor of 2, the content will have the same visual quality as the same content with set to 1.0 and a transform scale of 1. - When is set to 0, no bitmap is rendered. Negative values are clamped to 0. + When is set to 0, no bitmap is rendered. Negative values are clamped to 0. If you change this value, the cache is regenerated at the appropriate new resolution. @@ -338,7 +338,7 @@ ![RenderAtScale = 0.2](~/add/media/ndp-scale02.png "RenderAtScale = 0.2") - The following image shows a zoom transform that is applied to an ancestor of the cached element. When the zoom is set to 1 and is set to 1, the image quality is almost the same as when is set to 2. But when zoom is greater than 1, setting to 2 will have better image quality. + The following image shows a zoom transform that is applied to an ancestor of the cached element. When the zoom is set to 1 and is set to 1, the image quality is almost the same as when is set to 2. But when zoom is greater than 1, setting to 2 will have better image quality. **RenderAtScale = 1.0** @@ -409,7 +409,7 @@ property when the cache displays content that requires pixel-alignment to render correctly. This is the case for ClearType text. If you set the property to `true`, consider setting to `true` to ensure proper rendering. + Set the property when the cache displays content that requires pixel-alignment to render correctly. This is the case for ClearType text. If you set the property to `true`, consider setting to `true` to ensure proper rendering. When the property is set to `false`, you can move and scale the cached element by a fraction of a pixel, and bilinear filtering is applied. diff --git a/xml/System.Windows.Media/BitmapCacheBrush.xml b/xml/System.Windows.Media/BitmapCacheBrush.xml index 904ea949822..30fca1a00b0 100644 --- a/xml/System.Windows.Media/BitmapCacheBrush.xml +++ b/xml/System.Windows.Media/BitmapCacheBrush.xml @@ -42,25 +42,25 @@ | Bitmap Cache Property | Default Setting | |----------------------------------------------------------------|-----------------| -| | `false` | -| | `false` | -| | 1 | +| | `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. -- +- -- +- -- +- -- +- -- +- -- +- @@ -166,7 +166,7 @@ property is `true`, layout is applied to the contents of the brush if is a with no parent. + When the property is `true`, layout is applied to the contents of the brush if is a with no parent. ]]> diff --git a/xml/System.Windows.Media/BitmapScalingMode.xml b/xml/System.Windows.Media/BitmapScalingMode.xml index 8f78a097e83..d3ddac7c05f 100644 --- a/xml/System.Windows.Media/BitmapScalingMode.xml +++ b/xml/System.Windows.Media/BitmapScalingMode.xml @@ -31,7 +31,7 @@ ## Examples - The following example shows how to use the method to set the bitmap scale mode to `LowQuality` for an image object: + The following example shows how to use the method to set the bitmap scale mode to `LowQuality` for an image object: :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/BitmapScalingMode/Overview/Window1.xaml.cs" id="Snippetrenderoptionssnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/BitmapScalingMode/Overview/window1.xaml.vb" id="Snippetrenderoptionssnippet2"::: diff --git a/xml/System.Windows.Media/Brush.xml b/xml/System.Windows.Media/Brush.xml index b2d72e46f2d..f437bbc4c29 100644 --- a/xml/System.Windows.Media/Brush.xml +++ b/xml/System.Windows.Media/Brush.xml @@ -62,7 +62,7 @@ - : Paints an area with a object. A enables you to duplicate content from one portion of your application into another area; it's very useful for creating reflection effects and magnifying portions of the screen. ## Predefined Brushes - Use the class to paint an object using a predefined solid color, such as or . + Use the class to paint an object using a predefined solid color, such as or . ## Brushes in XAML The following table lists the different types that can be used in XAML and the syntax they support. For detailed syntax information for a specific brush, see that brush's type page. @@ -158,7 +158,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -197,7 +197,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -233,7 +233,7 @@ value of 0 indicates that the brush is completely transparent, while a value of 1 indicates that the brush is completely opaque. A value of 0.5 indicates the brush is 50% opaque, a value of 0.725 indicates the brush is 72.5% opaque, and so on. Values less than 0 are treated as 0, while values greater than 1 are treated as 1. + A value of 0 indicates that the brush is completely transparent, while a value of 1 indicates that the brush is completely opaque. A value of 0.5 indicates the brush is 50% opaque, a value of 0.725 indicates the brush is 72.5% opaque, and so on. Values less than 0 are treated as 0, while values greater than 1 are treated as 1. ## Dependency Property Information diff --git a/xml/System.Windows.Media/CachingHint.xml b/xml/System.Windows.Media/CachingHint.xml index 108e6c585dc..213d865c673 100644 --- a/xml/System.Windows.Media/CachingHint.xml +++ b/xml/System.Windows.Media/CachingHint.xml @@ -28,9 +28,9 @@ ## Remarks By default, WPF does not cache the rendered contents of and objects. In static scenarios where neither the contents nor the use of the brush in the scene is changing, not caching provides a benefit because it conserves video memory. When a brush with static content is used in a non-static way, the default behavior of WPF is to re-render the entire content of the brush every frame, even though the content is unchanging. For example, this will happen when a static or is mapped to the surface of a rotating 3D object. Re-rendering the static content can have a negative impact on performance. - By setting the attached property on the brush to Cache, you can increase performance by using cached versions of the tiled brush objects. + By setting the attached property on the brush to Cache, you can increase performance by using cached versions of the tiled brush objects. - The and property values are relative size values that determine when the object should be regenerated due to changes in scale. For example, by setting the property to 2.0, the cache for the only needs to be regenerated when its size exceeds twice the size of the current cache. + The and property values are relative size values that determine when the object should be regenerated due to changes in scale. For example, by setting the property to 2.0, the cache for the only needs to be regenerated when its size exceeds twice the size of the current cache. diff --git a/xml/System.Windows.Media/CharacterMetrics.xml b/xml/System.Windows.Media/CharacterMetrics.xml index af55de4cbbe..c5c1629d5f7 100644 --- a/xml/System.Windows.Media/CharacterMetrics.xml +++ b/xml/System.Windows.Media/CharacterMetrics.xml @@ -64,11 +64,11 @@ Initializes a new instance of the class. - object is constructed using the default metric values. - + object is constructed using the default metric values. + ]]> @@ -100,27 +100,27 @@ A comma-delimited value that represents the metrics for the character. Initializes a new instance of the class by specifying the metrics as a string. - properties in the following order: - -- - -- - -- - -- - -- - -- - -- - - The first two properties, and , are required. However, the other five properties are optional, and will default to zero if not specified. For example, if you specify the string value of "0.75,0.75,,0.1" for the `metrics` parameter, the , , and properties are set - the unspecified properties are set to zero. - + properties in the following order: + +- + +- + +- + +- + +- + +- + +- + + The first two properties, and , are required. However, the other five properties are optional, and will default to zero if not specified. For example, if you specify the string value of "0.75,0.75,,0.1" for the `metrics` parameter, the , , and properties are set - the unspecified properties are set to zero. + ]]> @@ -158,11 +158,11 @@ Gets the baseline value for the character. A value of type representing the baseline. - @@ -270,11 +270,11 @@ Gets the recommended white space below the black box. A value of type . - , , and . The vertical advance cannot be less than zero. - + , , and . The vertical advance cannot be less than zero. + ]]> @@ -311,23 +311,23 @@ if the objects are equal; otherwise, . - objects are equal if the following properties are equal: - - - - - - - - - - - - - + objects are equal if the following properties are equal: + + + + + + + + + + + + + ]]> @@ -395,13 +395,13 @@ Gets the recommended white space to the left of the black box. A value of type . - , , and . The horizontal advance cannot be less than zero. - + , , and . The horizontal advance cannot be less than zero. + ]]> @@ -433,27 +433,27 @@ Gets or sets a comma-delimited string representing metric values. A value of type . - value is a comma-delimited string that specifies the properties in the following order: - -- - -- - -- - -- - -- - -- - -- - - The first two properties, and , are required. However, the other five properties are optional, and will default to zero if not specified. For example, if you specify the string value of "`0.75,0.75,,0.1`" for the `metrics` parameter, the , , and properties are set - the unspecified properties are set to zero. - + value is a comma-delimited string that specifies the properties in the following order: + +- + +- + +- + +- + +- + +- + +- + + The first two properties, and , are required. However, the other five properties are optional, and will default to zero if not specified. For example, if you specify the string value of "`0.75,0.75,,0.1`" for the `metrics` parameter, the , , and properties are set - the unspecified properties are set to zero. + ]]> @@ -491,13 +491,13 @@ Gets the recommended white space to the right of the black box. A value of type . - , , and . The horizontal advance cannot be less than zero. - + , , and . The horizontal advance cannot be less than zero. + ]]> @@ -535,11 +535,11 @@ Gets the recommended white space above the black box. A value of type . - , , and . The vertical advance cannot be less than zero. - + , , and . The vertical advance cannot be less than zero. + ]]> diff --git a/xml/System.Windows.Media/ClearTypeHint.xml b/xml/System.Windows.Media/ClearTypeHint.xml index 9738a2b8246..c1da4b95539 100644 --- a/xml/System.Windows.Media/ClearTypeHint.xml +++ b/xml/System.Windows.Media/ClearTypeHint.xml @@ -22,11 +22,11 @@ An enumeration that specifies a hint to the rendering engine that text can be rendered with ClearType. - attached property to control how text is rendered on a translucent background. For more information, see . - + attached property to control how text is rendered on a translucent background. For more information, see . + ]]> diff --git a/xml/System.Windows.Media/Color.xml b/xml/System.Windows.Media/Color.xml index ccf2cd19c93..8ed71159d7f 100644 --- a/xml/System.Windows.Media/Color.xml +++ b/xml/System.Windows.Media/Color.xml @@ -70,36 +70,36 @@ One of the colors predefined by the class. *rgb* - A three-digit hexadecimal number. The first digit specifies the color's value, the second digit specifies the value, and the third digit specifies the value. For example, `00F`. + A three-digit hexadecimal number. The first digit specifies the color's value, the second digit specifies the value, and the third digit specifies the value. For example, `00F`. *argb* - A four-digit hexadecimal number. The first digit specifies the color's value, the second digit specifies its value, the next digit specifies the value, and the final digit specifies its value. For example, `F00F`. + A four-digit hexadecimal number. The first digit specifies the color's value, the second digit specifies its value, the next digit specifies the value, and the final digit specifies its value. For example, `F00F`. *rrggbb* - A six-digit hexadecimal number. The first two digits specify the color's value, the next two specify its value, and the final two specify its value. For example, `0000FF`. + A six-digit hexadecimal number. The first two digits specify the color's value, the next two specify its value, and the final two specify its value. For example, `0000FF`. *aarrggbb* - An eight-digit hexadecimal number. The first two digits specify the color's value, the next two specify its value, the next two specify its value, and the final two specify its value. For example, `FF0000FF`. + An eight-digit hexadecimal number. The first two digits specify the color's value, the next two specify its value, the next two specify its value, and the final two specify its value. For example, `FF0000FF`. *scA* - The color's value. + The color's value. *scR* - The color's value. + The color's value. *scG* - The color's value. + The color's value. *scB* - The color's value. + The color's value. *profileUri* @@ -159,7 +159,7 @@ ## Remarks The alpha channel of a structure determines the amount of transparency the has. An alpha value of 255 indicates the is completely opaque and a value of 0 indicates the color is completely transparent. - The `sRGB` channels (, , , ) and the ScRGB channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` alpha channel, is modified, the `ScRGB` alpha channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the ScRGB channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` alpha channel, is modified, the `ScRGB` alpha channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -291,7 +291,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` blue channel, is modified, the `ScRGB` blue channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` blue channel, is modified, the `ScRGB` blue channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -419,9 +419,9 @@ method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. + Floating-point values can acquire a small degree of error when they are operated upon. The method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. - The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. + The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. ]]> @@ -510,9 +510,9 @@ method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. + Floating-point values can acquire a small degree of error when they are operated upon. The method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. - The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. + The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. ]]> @@ -561,7 +561,7 @@ method allows you to specify the alpha channel; the method uses a default value of 255 for the alpha channel. + The method allows you to specify the alpha channel; the method uses a default value of 255 for the alpha channel. The alpha channel of a color determines the amount of transparency of the color. An alpha value of 255 indicates that the color is completely opaque, and a value of 0 indicates that the color is completely transparent. @@ -622,7 +622,7 @@ ## Examples - The following example shows how to use the method to create a structure. + The following example shows how to use the method to create a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Color/FromArgb/CreateColorsFromExample.cs" id="Snippetfromavaluesexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/Color/FromArgb/createcolorsfromexample.vb" id="Snippetfromavaluesexample"::: @@ -669,16 +669,16 @@ method allows you to specify the alpha channel; the method uses a default value of 1 for the alpha channel. + The method allows you to specify the alpha channel; the method uses a default value of 1 for the alpha channel. The alpha channel of a color determines the amount of transparency of the color. An alpha value of 1 indicates that the color is completely opaque, and a value of 0 indicates that the color is completely transparent. - The sRGB channels (, , , ) and the ScRGB channels (, , , ) of the structure are synchronized properties. For example, when , the sRGB red channel, is modified the ScRGB red channel, , is transformed to the equivalent value. + The sRGB channels (, , , ) and the ScRGB channels (, , , ) of the structure are synchronized properties. For example, when , the sRGB red channel, is modified the ScRGB red channel, , is transformed to the equivalent value. ## Examples - The following example shows how to use the method to create a structure. + The following example shows how to use the method to create a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Color/FromArgb/CreateColorsFromExample.cs" id="Snippetfromrgbexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/Color/FromArgb/createcolorsfromexample.vb" id="Snippetfromrgbexample"::: @@ -788,7 +788,7 @@ ## Examples - The following example shows how to use the method to create a structure. + The following example shows how to use the method to create a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Color/FromArgb/CreateColorsFromExample.cs" id="Snippetfromvaluesexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/Color/FromArgb/createcolorsfromexample.vb" id="Snippetfromvaluesexample"::: @@ -827,7 +827,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` green channel, is modified, the `ScRGB` green channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` green channel, is modified, the `ScRGB` green channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -973,7 +973,7 @@ ## Remarks structures are added together by adding the alpha, red, green, and blue channels of the first color to the alpha, red, green, and blue channels of the second color. For example, the alpha channel of `color1` and the alpha channel of `color2` are added together to produce the alpha channel of the resulting color. The same is done with the red, green, and blue channels to produce the red, green, and blue channels of the new color. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -1014,11 +1014,11 @@ method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. + Floating-point values can acquire a small degree of error when they are operated upon. The method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. - The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. + The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -1062,11 +1062,11 @@ method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. + Floating-point values can acquire a small degree of error when they are operated upon. The method, the operator, and the operator do not compensate for this and thus may not return the expected Boolean result. - The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. + The method uses a fuzzy equality algorithm that compensates for this floating-point arithmetic error by returning `true` for a comparison of two structures that are practically identical, but whose values may differ by a minuscule amount. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -1106,7 +1106,7 @@ Multiplies the alpha, red, blue, and green channels of the specified structure by the specified value. A new structure whose color values are the results of the multiplication operation. - ]]> + ]]> @@ -1149,7 +1149,7 @@ ## Remarks structures are subtracted from one another by subtracting the alpha, red, green, and blue channels of the second color from the alpha, red, green, and blue channels of the first color. For example, the alpha channel of `color2` is subtracted from the alpha channel of `color1` to produce the alpha channel of the resulting structure. The same is done with the red, green, and blue channels to produce the red, green, and blue channels of the new structure. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -1183,7 +1183,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` red channel, is modified, the `ScRGB` red channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` red channel, is modified, the `ScRGB` red channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -1221,7 +1221,7 @@ ## Remarks The alpha channel of a structure determines the amount of transparency the has. An alpha value of 1 indicates the is completely opaque and a value of 0 indicates the color is completely transparent. - The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` alpha channel, is modified, the `ScRGB` alpha channel, is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` alpha channel, is modified, the `ScRGB` alpha channel, is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -1257,7 +1257,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` blue channel, is modified, the `ScRGB` blue channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` blue channel, is modified, the `ScRGB` blue channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -1293,7 +1293,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` green channel, is modified, the `ScRGB` green channel, is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` green channel, is modified, the `ScRGB` green channel, is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> @@ -1329,7 +1329,7 @@ , , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` red channel, is modified, the `ScRGB` red channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. + The `sRGB` channels (, , , ) and the `ScRGB` channels (, , , ) of the structure are synchronized properties. For example, when , the `sRGB` red channel, is modified, the `ScRGB` red channel, , is converted to the equivalent value using the 0-1 range that the `Sc` scheme supports. ]]> diff --git a/xml/System.Windows.Media/ColorContext.xml b/xml/System.Windows.Media/ColorContext.xml index 6a2da33ba2a..5e929af34a0 100644 --- a/xml/System.Windows.Media/ColorContext.xml +++ b/xml/System.Windows.Media/ColorContext.xml @@ -24,19 +24,19 @@ Represents the International Color Consortium (ICC) or Image Color Management (ICM) color profile that is associated with a bitmap image. - @@ -87,11 +87,11 @@ The that identifies the location of the desired color profile. Initializes a new instance of with the International Color Consortium (ICC) or Image Color Management (ICM) color profile located at a given . - by using the constructor. - + by using the constructor. + ]]> @@ -129,14 +129,14 @@ The from which the is derived. Initializes a new instance of with the standard color profile (sRGB or RGB ) that most closely matches the supplied . - . - + . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ColorContext/Overview/BitmapImageProps.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/BitmapImageProps/VB/BitmapImageProps.vb" id="Snippet3"::: + ]]> diff --git a/xml/System.Windows.Media/ColorConverter.xml b/xml/System.Windows.Media/ColorConverter.xml index 00f413a945a..b7eadda31af 100644 --- a/xml/System.Windows.Media/ColorConverter.xml +++ b/xml/System.Windows.Media/ColorConverter.xml @@ -164,11 +164,11 @@ Attempts to convert the specified object to a . The created from converting . - method. - + method. + ]]> @@ -251,11 +251,11 @@ Attempts to convert a to a specified type. The object created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/CombinedGeometry.xml b/xml/System.Windows.Media/CombinedGeometry.xml index fadefca3dcb..220595f2bb9 100644 --- a/xml/System.Windows.Media/CombinedGeometry.xml +++ b/xml/System.Windows.Media/CombinedGeometry.xml @@ -30,15 +30,15 @@ ## Remarks The property specifies how the two geometries will be combined. Note that combines the area specified by two geometries, so geometries that do not have area (such as ) disappear when combined. - Geometries can be combined in several ways: using a , a , or the method of the class. + Geometries can be combined in several ways: using a , a , or the method of the class. - A creates a composite geometry from one or more objects. - A uses a specified boolean operation to combine the area described by two objects. -- The static method of the class behaves in exactly the same manner as the object. +- The static method of the class behaves in exactly the same manner as the object. - Careful thought should be involved when using a to perform a union as it can be very CPU-expensive. In most cases, a or will work better. + Careful thought should be involved when using a to perform a union as it can be very CPU-expensive. In most cases, a or will work better. Use a only when any of the following apply: @@ -46,9 +46,9 @@ - Either of the geometries have a value of and the geometries are self-intersecting (i.e. the actually matters). -- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . +- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . -- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. +- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. ## Freezable Features A is a type of object. For information about features, such as freezing and cloning, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -260,7 +260,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -299,7 +299,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/ContainerVisual.xml b/xml/System.Windows.Media/ContainerVisual.xml index a980cc4af3b..760897668c4 100644 --- a/xml/System.Windows.Media/ContainerVisual.xml +++ b/xml/System.Windows.Media/ContainerVisual.xml @@ -32,7 +32,7 @@ ## Examples - The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. + The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ContainerVisual/Overview/Window1.xaml.cs" id="Snippetcontainervisualhost01"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/ContainerVisual/Overview/window1.xaml.vb" id="Snippetcontainervisualhost01"::: @@ -419,7 +419,7 @@ ## Examples - The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. + The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ContainerVisual/Overview/Window1.xaml.cs" id="Snippetcontainervisualhost01"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/ContainerVisual/Overview/window1.xaml.vb" id="Snippetcontainervisualhost01"::: @@ -481,7 +481,7 @@ ## Examples - The following example shows how to retrieve the return value from the method. + The following example shows how to retrieve the return value from the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ContainerVisual/.ctor/Window1.xaml.cs" id="Snippetcontainervisualsnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/ContainerVisual/.ctor/window1.xaml.vb" id="Snippetcontainervisualsnippet2"::: @@ -738,7 +738,7 @@ ## Examples - The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. + The following example shows how to create a object that is used as the parent for two objects. Objects that are added to the object must be added in reverse z-order (bottom to top) to ensure they are rendering in the correct drawing order. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/ContainerVisual/Overview/Window1.xaml.cs" id="Snippetcontainervisualhost01"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/ContainerVisual/Overview/window1.xaml.vb" id="Snippetcontainervisualhost01"::: diff --git a/xml/System.Windows.Media/DashStyle.xml b/xml/System.Windows.Media/DashStyle.xml index d22031add7e..6fbdd5b2dd0 100644 --- a/xml/System.Windows.Media/DashStyle.xml +++ b/xml/System.Windows.Media/DashStyle.xml @@ -35,10 +35,10 @@ property of this class describes the length of alternating dashes and gaps. The values in the collection are in terms of multiples of the of the . For example, an array of `1`,`2` specifies a dash of length (`1` * ) followed by a gap of length (`2` * ). + The property of this class describes the length of alternating dashes and gaps. The values in the collection are in terms of multiples of the of the . For example, an array of `1`,`2` specifies a dash of length (`1` * ) followed by a gap of length (`2` * ). > [!NOTE] -> The actual length of the dash that is drawn depends on the style of that is added to each end of the dash. The default value for a is . This causes an end cap that is one half the thickness of the line to be added onto each end of the pen stroke. (See for an example.) Therefore, if you specify an array of `0`, `2` and a square , the actual dash length will be (`0` * ) + (`2` * ). +> The actual length of the dash that is drawn depends on the style of that is added to each end of the dash. The default value for a is . This causes an end cap that is one half the thickness of the line to be added onto each end of the pen stroke. (See for an example.) Therefore, if you specify an array of `0`, `2` and a square , the actual dash length will be (`0` * ) + (`2` * ). If there are an odd number of values in the collection, the values are interpreted as if they had been repeated once to produce an even number of values. For example, a collection containing `2`,`3`,`5` is interpreted the same as a collection containing `2`,`3`,`5`,`2`,`3`,`5`. @@ -162,7 +162,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (they might no longer resolve) but not animations or their current values. @@ -203,7 +203,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . Resource references, data bindings, and animations are not copied, but their current values are. @@ -271,10 +271,10 @@ of the . For example, an array of `1`,`2` specifies a dash of length (`1` * ) followed by a gap of length (`2` * ). + This collection describes the length of alternating dashes and gaps. The values in the collection are in terms of multiples of the of the . For example, an array of `1`,`2` specifies a dash of length (`1` * ) followed by a gap of length (`2` * ). > [!NOTE] -> The actual length of the dash that is drawn depends on the style of that is added to each end of the dash. The default value for a is . This causes an end cap that is one half the thickness of the line to be added onto each end of the pen stroke. (See for an example.) Therefore, if you specify an array of `0`, `2` and a square , the actual dash length will be (`0` * ) + (`2` * ). +> The actual length of the dash that is drawn depends on the style of that is added to each end of the dash. The default value for a is . This causes an end cap that is one half the thickness of the line to be added onto each end of the pen stroke. (See for an example.) Therefore, if you specify an array of `0`, `2` and a square , the actual dash length will be (`0` * ) + (`2` * ). If there are an odd number of values in the collection, the values are interpreted as if they had been repeated once to produce an even number of values. For example, a collection containing `2`,`3`,`5` is interpreted the same as a collection containing `2`,`3`,`5`,`2`,`3`,`5`. diff --git a/xml/System.Windows.Media/DoubleCollection.xml b/xml/System.Windows.Media/DoubleCollection.xml index a18e429d1fc..45d3154e336 100644 --- a/xml/System.Windows.Media/DoubleCollection.xml +++ b/xml/System.Windows.Media/DoubleCollection.xml @@ -67,7 +67,7 @@ , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. + Members of this class behave exactly as described by the , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -304,7 +304,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -375,7 +375,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -658,13 +658,13 @@ ## Remarks Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + Initially, the enumerator is positioned before the first item in the collection. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - returns the same object until either or is called. sets to the next item. + returns the same object until either or is called. sets to the next item. - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. @@ -748,7 +748,7 @@ , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. ]]> @@ -955,7 +955,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -995,7 +995,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media/DoubleCollectionConverter.xml b/xml/System.Windows.Media/DoubleCollectionConverter.xml index f76dc978914..71491caa31a 100644 --- a/xml/System.Windows.Media/DoubleCollectionConverter.xml +++ b/xml/System.Windows.Media/DoubleCollectionConverter.xml @@ -164,11 +164,11 @@ Attempts to convert the specified object to a . The that is created from converting . - method. - + method. + ]]> @@ -210,11 +210,11 @@ Attempts to convert a to a specified type. The object you create when you convert this . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/Drawing.xml b/xml/System.Windows.Media/Drawing.xml index bb103bc2c7e..ba1bae11361 100644 --- a/xml/System.Windows.Media/Drawing.xml +++ b/xml/System.Windows.Media/Drawing.xml @@ -31,18 +31,18 @@ Abstract class that describes a 2-D drawing. This class cannot be inherited by your code. - objects are light-weight objects that enable you to add geometric shapes, images, text, and media to an application. objects are considered light-weight because they do not provide support for [Layout](/dotnet/framework/wpf/advanced/layout), [Input Overview](/dotnet/framework/wpf/advanced/input-overview), and focus. Because of their performance benefits, drawings are ideal for backgrounds and clip art. You also use drawings when programming at the level. - - Because they inherit from the class, objects provide additional features that make them useful for describing clip art and backgrounds: they can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - There are different types of objects for different types of content: , , , , and . - -## Freezable Features - A is a type of object. For information about features, such as freezing and cloning, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - + objects are light-weight objects that enable you to add geometric shapes, images, text, and media to an application. objects are considered light-weight because they do not provide support for [Layout](/dotnet/framework/wpf/advanced/layout), [Input Overview](/dotnet/framework/wpf/advanced/input-overview), and focus. Because of their performance benefits, drawings are ideal for backgrounds and clip art. You also use drawings when programming at the level. + + Because they inherit from the class, objects provide additional features that make them useful for describing clip art and backgrounds: they can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + There are different types of objects for different types of content: , , , , and . + +## Freezable Features + A is a type of object. For information about features, such as freezing and cloning, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + ]]> @@ -110,13 +110,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -149,13 +149,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media/DrawingBrush.xml b/xml/System.Windows.Media/DrawingBrush.xml index 6a2d1f8e42e..b2431da8c29 100644 --- a/xml/System.Windows.Media/DrawingBrush.xml +++ b/xml/System.Windows.Media/DrawingBrush.xml @@ -135,7 +135,7 @@ Shapes and text painted with a drawing brush ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -174,7 +174,7 @@ Shapes and text painted with a drawing brush ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/DrawingCollection.xml b/xml/System.Windows.Media/DrawingCollection.xml index d4d12f9ee06..cc188265f16 100644 --- a/xml/System.Windows.Media/DrawingCollection.xml +++ b/xml/System.Windows.Media/DrawingCollection.xml @@ -51,29 +51,29 @@ Represents an ordered collection of objects. - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreDrawingObjectElements - - -``` - - -## XAML Values - *oneOrMoreDrawingObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreDrawingObjectElements + + +``` + + +## XAML Values + *oneOrMoreDrawingObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -209,19 +209,19 @@ The item to add to the end of this collection. Adds a to the end of the . - , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -257,11 +257,11 @@ Removes all the items from this . - . - + . + ]]> The is read-only. @@ -296,13 +296,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -367,13 +367,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -488,10 +488,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -684,21 +684,21 @@ Returns an enumerator that can iterate through the collection. An enumerator that can iterate the collection. - throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -776,21 +776,21 @@ The item to insert. Inserts a into this at the specified index position. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -829,21 +829,21 @@ Gets or sets the at the specified zero-based index. The at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -883,10 +883,10 @@ if the operation was successful; otherwise, . To be added. - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -959,11 +959,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -999,11 +999,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1043,11 +1043,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1084,11 +1084,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1123,11 +1123,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1163,11 +1163,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1207,11 +1207,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1252,11 +1252,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1296,11 +1296,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1341,11 +1341,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1382,11 +1382,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1422,11 +1422,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1471,11 +1471,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1514,11 +1514,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/DrawingContext.xml b/xml/System.Windows.Media/DrawingContext.xml index ee9e08c5eb2..eb2b7579ff7 100644 --- a/xml/System.Windows.Media/DrawingContext.xml +++ b/xml/System.Windows.Media/DrawingContext.xml @@ -35,7 +35,7 @@ Although the draw methods appear similar to the draw methods of the type, they function very differently: is used with a retained mode graphics system, while the type is used with an immediate mode graphics system. When you use a object's draw commands, you are actually storing a set of rendering instructions (although the exact storage mechanism depends on the type of object that supplies the ) that will later be used by the graphics system; you are not drawing to the screen in real-time. For more information about how the Windows Presentation Foundation (WPF) graphics system works, see [WPF Graphics Rendering Overview](/dotnet/framework/wpf/graphics-multimedia/wpf-graphics-rendering-overview). - You never directly instantiate a ; you can, however, acquire a drawing context from certain methods, such as and . + You never directly instantiate a ; you can, however, acquire a drawing context from certain methods, such as and . @@ -45,7 +45,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/Window1.xaml.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet101"::: - The next example demonstrates the command. The is obtained from a and displayed using an control. + The next example demonstrates the command. The is obtained from a and displayed using an control. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/PushEffectExample.cs" id="Snippetpusheffectexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/pusheffectexample.vb" id="Snippetpusheffectexamplewholepage"::: @@ -123,7 +123,7 @@ method instead. + Do not call this method directly from your code; use the method instead. ]]> @@ -791,7 +791,7 @@ command to draw a rectangle and fill it with a that contains media. + Note that the media will be stretched to fit inside the area defined by the rectangle parameter. If rectangle and media have different aspect ratios, distortion will occur. For more control over how media is used to fill an area, use the command to draw a rectangle and fill it with a that contains media. ]]> @@ -834,7 +834,7 @@ command to draw a rectangle and fill it with a that contains media. + Note that the media will be stretched to fit inside the area defined by the rectangle parameter. If rectangle and media have different aspect ratios, distortion will occur. For more control over how media is used to fill an area, use the command to draw a rectangle and fill it with a that contains media. ]]> @@ -875,7 +875,7 @@ ## Examples - The following example shows the effect of the command. + The following example shows the effect of the command. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/PopExample.cs" id="Snippetpopexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/popexample.vb" id="Snippetpopexamplewholepage"::: @@ -921,7 +921,7 @@ command. + The clip region applies to all subsequent drawing commands until it is removed by the command. ]]> @@ -967,7 +967,7 @@ command. + The effect is applied to all subsequent drawing operations until it is removed by the command. ]]> @@ -1006,7 +1006,7 @@ operation. + The guideline set applies to all subsequent drawing commands until it is removed by the operation. ]]> @@ -1055,12 +1055,12 @@ command. + The opacity is blended into all subsequent drawing commands until it is removed by the command. ## Examples - The following example demonstrates the , , and commands. + The following example demonstrates the , , and commands. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/PushEffectExample.cs" id="Snippetpusheffectexamplewholepage"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/pusheffectexample.vb" id="Snippetpusheffectexamplewholepage"::: @@ -1104,7 +1104,7 @@ command. + The opacity is blended into all subsequent drawing commands until it is removed by the command. ]]> @@ -1143,7 +1143,7 @@ operation. + The mask is applied to all subsequent drawing commands until it is removed by the operation. For more information about creating opacity masks, see [Opacity Masks Overview](/dotnet/framework/wpf/graphics-multimedia/opacity-masks-overview). @@ -1184,7 +1184,7 @@ command. + The transform applies to all subsequent drawing commands until it is removed by the command. ]]> diff --git a/xml/System.Windows.Media/DrawingGroup.xml b/xml/System.Windows.Media/DrawingGroup.xml index fc25b0a98d5..25c0daa6bd8 100644 --- a/xml/System.Windows.Media/DrawingGroup.xml +++ b/xml/System.Windows.Media/DrawingGroup.xml @@ -34,7 +34,7 @@ to combine multiple drawings into a single, composite drawing. Unlike other objects, you can apply a , , setting, , , or a to a . The flexibility of this class enables you to create complex scenes. + Use a to combine multiple drawings into a single, composite drawing. Unlike other objects, you can apply a , , setting, , , or a to a . The flexibility of this class enables you to create complex scenes. Because is also a , it can contain other objects. @@ -144,15 +144,15 @@ operations are applied in the following order: -- +- -- +- -- +- -- +- -- +- ## Dependency Property Information @@ -390,17 +390,17 @@ operations are applied in the following order: -1. +1. -2. +2. -3. +3. -4. +4. -5. +5. -6. +6. ## Dependency Property Information @@ -423,7 +423,7 @@ ![DrawingGroup with a defined clip region](~/add/media/graphicsmm-clipgeom.png "DrawingGroup with a defined clip region") - The following example uses a to apply a to several objects. + The following example uses a to apply a to several objects. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingGroup/BitmapEffect/ClipExample.cs" id="Snippetdrawinggroupclipgeometryexamplewholepage"::: :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/DrawingMiscSnippets_snip/XAML/ClipExample.xaml" id="Snippetdrawinggroupclipgeometryexamplewholepage"::: @@ -495,7 +495,7 @@ When this method copies dependency properties, it copies resource references and data bindings even though they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -536,7 +536,7 @@ This method does not copy resource references, data bindings, and animations, although it does copy their current values. - For more information, see . + For more information, see . ]]> @@ -602,7 +602,7 @@ of this is applied after the . As a result, the is transformed along with the contents of the . + The of this is applied after the . As a result, the is transformed along with the contents of the . ## Dependency Property Information @@ -676,21 +676,21 @@ ## Remarks A value of `1` specifies that the is completely opaque; a value of `0` specifies that it is completely transparent. A value that is less than 0 is treated as 0, and a value that is larger than 1 is treated as 1. - Another way to control the opacity of a is to specify the of its . + Another way to control the opacity of a is to specify the of its . operations are applied in the following order: -1. +1. -2. +2. -3. +3. -4. +4. -5. +5. -6. +6. ## Dependency Property Information @@ -707,13 +707,13 @@ To change the opacity of a object, add it to a and set the property of the object. - The setting of the object is multiplied by the opacity of its child drawings; for example, if a has an of 0.5 and it contains a that has a 50 percent opaque , the brush is 25 percent opaque (0.5 * 0.5). + The setting of the object is multiplied by the opacity of its child drawings; for example, if a has an of 0.5 and it contains a that has a 50 percent opaque , the brush is 25 percent opaque (0.5 * 0.5). - To alter the opacity of select portions of a drawing, use an . + To alter the opacity of select portions of a drawing, use an . The following example uses a to combine several objects. The example also sets the opacity of the object to 0.25 so that the drawings are 25 percent opaque. - This illustration shows the before and after its is set to 0.25. + This illustration shows the before and after its is set to 0.25. ![DrawingGroups with different opacity settings](~/add/media/graphicsmm-opacity.png "DrawingGroups with different opacity settings") @@ -757,21 +757,21 @@ ## Remarks The is mapped to the . The opacity value of each pixel of the mapped is used to determine the resulting opacity of each corresponding pixel of the . Only the opacity value of each color in the brush is used for this processing; all other color information is ignored. - The opacity that this property specifies is multiplied with the value of the object. For more information about opacity masks and how they work, see [Opacity Masks Overview](/dotnet/framework/wpf/graphics-multimedia/opacity-masks-overview). + The opacity that this property specifies is multiplied with the value of the object. For more information about opacity masks and how they work, see [Opacity Masks Overview](/dotnet/framework/wpf/graphics-multimedia/opacity-masks-overview). operations are applied in the following order: -1. +1. -2. +2. -3. +3. -4. +4. -5. +5. -6. +6. ## Dependency Property Information @@ -933,17 +933,17 @@ operations are applied in the following order: -1. +1. -2. +2. -3. +3. -4. +4. -5. +5. -6. +6. ## Dependency Property Information @@ -956,7 +956,7 @@ ## Examples - This example shows how to apply a to a . To transform a object, you add it to a and set the property of the object. + This example shows how to apply a to a . To transform a object, you add it to a and set the property of the object. The class is the only type of object that supports transforms. To apply multiple transforms to a single , use a . diff --git a/xml/System.Windows.Media/DrawingImage.xml b/xml/System.Windows.Media/DrawingImage.xml index c1be125e435..f0ceb8a6a06 100644 --- a/xml/System.Windows.Media/DrawingImage.xml +++ b/xml/System.Windows.Media/DrawingImage.xml @@ -124,7 +124,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -163,7 +163,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/DrawingVisual.xml b/xml/System.Windows.Media/DrawingVisual.xml index a16873d6403..59c892cfbf2 100644 --- a/xml/System.Windows.Media/DrawingVisual.xml +++ b/xml/System.Windows.Media/DrawingVisual.xml @@ -70,12 +70,12 @@ object, it has no drawing content. You can add text, graphic, or image content by retrieving the drawing context of the object and drawing into it. A drawing context is returned by calling the method of a object. + When you create a object, it has no drawing content. You can add text, graphic, or image content by retrieving the drawing context of the object and drawing into it. A drawing context is returned by calling the method of a object. ## Examples - In the following example, a object is created, and a rectangle is drawn into its drawing context. Notice that you must call the method of the to persist drawing content. + In the following example, a object is created, and a rectangle is drawn into its drawing context. Notice that you must call the method of the to persist drawing content. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/Window1.xaml.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet101"::: @@ -244,7 +244,7 @@ method of the , the current drawing content replaces any previous drawing content defined for the . This means that there is no way to append new drawing content to existing drawing content. + When you call the method of the , the current drawing content replaces any previous drawing content defined for the . This means that there is no way to append new drawing content to existing drawing content. diff --git a/xml/System.Windows.Media/EdgeMode.xml b/xml/System.Windows.Media/EdgeMode.xml index 6d32e77caee..0849979b42b 100644 --- a/xml/System.Windows.Media/EdgeMode.xml +++ b/xml/System.Windows.Media/EdgeMode.xml @@ -23,21 +23,21 @@ Determines how the edges of non-text drawing primitives are rendered. - and , is `Unspecified`. - - When you set the edge mode value of a visual object, all the child drawing primitives of that visual object are set to the same `EdgeMode` value. - - - -## Examples - The following example shows how to use the method to set the edge mode for a drawing primitive to `Aliased`: - + and , is `Unspecified`. + + When you set the edge mode value of a visual object, all the child drawing primitives of that visual object are set to the same `EdgeMode` value. + + + +## Examples + The following example shows how to use the method to set the edge mode for a drawing primitive to `Aliased`: + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Snippets.cs" id="Snippetsetedgemode"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/snippets.vb" id="Snippetsetedgemode"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/snippets.vb" id="Snippetsetedgemode"::: + ]]> diff --git a/xml/System.Windows.Media/EllipseGeometry.xml b/xml/System.Windows.Media/EllipseGeometry.xml index 913ed0c9b1e..d57fd942b31 100644 --- a/xml/System.Windows.Media/EllipseGeometry.xml +++ b/xml/System.Windows.Media/EllipseGeometry.xml @@ -31,7 +31,7 @@ Use the class with a element or a to draw an ellipse, or with the property of a to define an elliptical clip region. The class also has many other uses. For more information about , see [Geometry Overview](/dotnet/framework/wpf/graphics-multimedia/geometry-overview). ## EllipseGeometry Compared to Ellipse - The class has a , , and other rendering properties that lacks. The class is a and therefore participates in the layout system; it can be used as the content of any element that supports children. + The class has a , , and other rendering properties that lacks. The class is a and therefore participates in the layout system; it can be used as the content of any element that supports children. The class, on the other hand, simply defines the geometry of an ellipse, and cannot render itself. Because of its simplicity, it has a wider range of uses. @@ -321,7 +321,7 @@ Two EllipseGeometry objects ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -360,7 +360,7 @@ Two EllipseGeometry objects ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -432,7 +432,7 @@ Two EllipseGeometry objects methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but they require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but they require more processing than an approximation with a large tolerance factor. ]]> diff --git a/xml/System.Windows.Media/FamilyTypeface.xml b/xml/System.Windows.Media/FamilyTypeface.xml index e2bf5e1a931..8e044b81ff5 100644 --- a/xml/System.Windows.Media/FamilyTypeface.xml +++ b/xml/System.Windows.Media/FamilyTypeface.xml @@ -24,11 +24,11 @@ Specifies the details of a single typeface supported by a . - objects as there are typefaces supported by the system. - + objects as there are typefaces supported by the system. + ]]> @@ -303,11 +303,11 @@ Serves as a hash function for a object. The method is suitable for use in hashing algorithms and data structures like a hash table. A value of type . - , , and properties of the object. - + , , and properties of the object. + ]]> @@ -345,11 +345,11 @@ Gets or sets the designed stretch of the font family typeface. A value of type . - value describes the degree to which the font has been stretched compared to the font's normal aspect ratio. - + value describes the degree to which the font has been stretched compared to the font's normal aspect ratio. + ]]> @@ -387,11 +387,11 @@ Gets or sets the position of the strikethrough value relative to the baseline. The value is also relative to em size. A value of type . - is usually positive in order to place the strikethrough above the baseline. - + is usually positive in order to place the strikethrough above the baseline. + ]]> @@ -464,11 +464,11 @@ Gets or sets the style of the font family typeface design. A value of type . - @@ -506,11 +506,11 @@ Gets or sets the position of underline value relative to the baseline. The value is also relative to em size. A value of type . - is usually negative in order to place the underline below the baseline. - + is usually negative in order to place the underline below the baseline. + ]]> @@ -583,11 +583,11 @@ Gets or sets the designed weight of this font family typeface. A value of type . - value describes the relative weight of a given font. Weight differences are generally differentiated by an increased stroke or thickness associated with a given character in a font, as compared to a "normal" character from that same font. - + value describes the relative weight of a given font. Weight differences are generally differentiated by an increased stroke or thickness associated with a given character in a font, as compared to a "normal" character from that same font. + ]]> diff --git a/xml/System.Windows.Media/FontFamily.xml b/xml/System.Windows.Media/FontFamily.xml index dedc8abda3f..44f2530c797 100644 --- a/xml/System.Windows.Media/FontFamily.xml +++ b/xml/System.Windows.Media/FontFamily.xml @@ -41,7 +41,7 @@ , such as italic, and , such as bold. + A font family is a set of typefaces that share the same family name, such as "Times New Roman", but that differ in features. These feature differences include , such as italic, and , such as bold. ![Fonts](~/add/media/fonts.PNG "Fonts") Example of typefaces that are members of the "Times New Roman" font family @@ -190,7 +190,7 @@ Example of typefaces that are members of the "Times New Roman" font family and collections prior to using the constructed instance. + Use this parameterless constructor when you want to create a composite font programmatically. This means that you do not have to specify a font family name for the constructor, but you must populate the collections in the and collections prior to using the constructed instance. ]]> @@ -686,14 +686,14 @@ Example of typefaces that are members of the "Times New Roman" font family object, use the . + To return the base uniform resource identifier (URI) value of a object, use the . If the object was created without specifying a font family name, the return value is . ## Examples - The following example shows the results of retrieving the and property values from a object. + The following example shows the results of retrieving the and property values from a object. :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontPackageSnippets.xaml.cs" id="Snippetfontpackagesnippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontpackagesnippets.xaml.vb" id="Snippetfontpackagesnippet10"::: diff --git a/xml/System.Windows.Media/FontFamilyMap.xml b/xml/System.Windows.Media/FontFamilyMap.xml index f2732182969..52937097c8e 100644 --- a/xml/System.Windows.Media/FontFamilyMap.xml +++ b/xml/System.Windows.Media/FontFamilyMap.xml @@ -164,7 +164,7 @@ allows the target size to be adjusted so that it better matches the size of other fonts used in the composite font family. The scale factor is relative to "em" units. + The allows the target size to be adjusted so that it better matches the size of other fonts used in the composite font family. The scale factor is relative to "em" units. diff --git a/xml/System.Windows.Media/Fonts.xml b/xml/System.Windows.Media/Fonts.xml index 253ce272efb..7f3d1df2342 100644 --- a/xml/System.Windows.Media/Fonts.xml +++ b/xml/System.Windows.Media/Fonts.xml @@ -24,14 +24,14 @@ Provides enumeration support for and objects. - , such as italic, and , such as bold. - - ![Fonts](~/add/media/fonts.PNG "Fonts") -Example of typefaces that are "Times New Roman" font family members - + , such as italic, and , such as bold. + + ![Fonts](~/add/media/fonts.PNG "Fonts") +Example of typefaces that are "Times New Roman" font family members + ]]> @@ -78,14 +78,14 @@ Example of typefaces that are "Times New Roman" font family members Returns the collection of objects from a string value that represents the location of the fonts. An of objects that represent the fonts in . - objects from a font location. - + objects from a font location. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/Window1.xaml.cs" id="Snippet100"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/window1.xaml.vb" id="Snippet100"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/window1.xaml.vb" id="Snippet100"::: + ]]> The is . You cannot pass , because this parameter is treated as a path or URI. @@ -122,19 +122,19 @@ Example of typefaces that are "Times New Roman" font family members Returns a collection of objects from a uniform resource identifier (URI) value that represents the location of the fonts. An of objects that represent the fonts in . - objects from a base URI location. - + objects from a base URI location. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet1"::: - - To return the collection of objects in an application's resources, use the "pack://application" URI notation shown in the following example. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet1"::: + + To return the collection of objects in an application's resources, use the "pack://application" URI notation shown in the following example. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet2"::: + ]]> @@ -172,14 +172,14 @@ Example of typefaces that are "Times New Roman" font family members Returns a collection of objects using a base uniform resource identifier (URI) value to resolve the font location. An of objects that represent the fonts in the resolved font location. - objects from the resolved font location. In this case, the application contains a subdirectory named "resources". - + objects from the resolved font location. In this case, the application contains a subdirectory named "resources". + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet3"::: + ]]> @@ -224,14 +224,14 @@ Example of typefaces that are "Times New Roman" font family members Returns the collection of objects from a string value that represents the font directory location. An of objects that represent the fonts in . - objects from a font location. - + objects from a font location. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet4"::: + ]]> The is . You cannot pass , because this parameter is treated as a path or URI. @@ -268,19 +268,19 @@ Example of typefaces that are "Times New Roman" font family members Returns a collection of objects from a uniform resource identifier (URI) value that represents the font location. An of objects that represent the fonts in . - objects from a base URI location. - + objects from a base URI location. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet5"::: - - To return the collection of objects in an application's resources, use the "pack://application" URI notation shown in the following example. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet5"::: + + To return the collection of objects in an application's resources, use the "pack://application" URI notation shown in the following example. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet6"::: + ]]> @@ -318,14 +318,14 @@ Example of typefaces that are "Times New Roman" font family members Returns a collection of objects using a base uniform resource identifier (URI) value to resolve the font location. An of objects that represent the fonts in the resolved font location. - objects from the resolved font location. In this case, the application contains a subdirectory named "resources". - + objects from the resolved font location. In this case, the application contains a subdirectory named "resources". + :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontFamilySnippets.xaml.cs" id="Snippetfontssnippet7"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/fontfamilysnippets.xaml.vb" id="Snippetfontssnippet7"::: + ]]> diff --git a/xml/System.Windows.Media/FormattedText.xml b/xml/System.Windows.Media/FormattedText.xml index 43841330435..023bd8ff9bb 100644 --- a/xml/System.Windows.Media/FormattedText.xml +++ b/xml/System.Windows.Media/FormattedText.xml @@ -624,7 +624,7 @@ Example of an image brush applied to the stroke and highlight are used instead of the property value. + If the text lines exceed the number of elements in the array, the last element value is used for the remaining lines. If the array of lengths is not `null`, the array values of are used instead of the property value. ]]> @@ -689,7 +689,7 @@ Example of an image brush applied to the stroke and highlight constructor. + The default line height is automatically calculated, and is based on the font value that is passed as a parameter to the constructor. ]]> @@ -731,7 +731,7 @@ Example of an image brush applied to the stroke and highlight property to control how omitted text is represented when the text exceeds the . + Use the property to control how omitted text is represented when the text exceeds the . ]]> @@ -773,12 +773,12 @@ Example of an image brush applied to the stroke and highlight limit or the line number that does not exceed the property, whichever occurs first. + The last line of text displayed is the last whole line that will fit within the limit or the line number that does not exceed the property, whichever occurs first. ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -823,7 +823,7 @@ Example of an image brush applied to the stroke and highlight limit. + Text will wrap to avoid exceeding the limit. Glyph alignment edges must be kept within the line count limits. Because many fonts contain glyphs that slightly overhang their alignment edges, allow at least 1/6 em (font size) margin beyond the line count requested, to leave room for such overhangs. @@ -832,7 +832,7 @@ Example of an image brush applied to the stroke and highlight ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -876,7 +876,7 @@ Example of an image brush applied to the stroke and highlight ![Text Formatter using the minimum paragraph width](~/add/media/textformatter03.png "Text Formatter using the minimum paragraph width") Minimum text width - If the value passed to is greater than or equal to the value of , the text is formatted without ellipsis characters. + If the value passed to is greater than or equal to the value of , the text is formatted without ellipsis characters. @@ -992,7 +992,7 @@ Minimum text width value will be positive when the trailing drawn pixel comes before the trailing alignment point. + The value will be positive when the trailing drawn pixel comes before the trailing alignment point. ]]> @@ -1070,7 +1070,7 @@ Minimum text width ## Remarks The class holds culture-specific information, such as the associated language, sublanguage, country/region, calendar, and cultural conventions. This class also provides access to culture-specific instances of , , , and . These objects contain the information required for culture-specific operations, such as casing, formatting dates and numbers, and comparing strings. - This method sets the culture information value for the entire text string. To set the culture information value for a subset of the text string, use the method. + This method sets the culture information value for the entire text string. To set the culture information value for a subset of the text string, use the method. ]]> @@ -1115,7 +1115,7 @@ Minimum text width ## Remarks The class holds culture-specific information, such as the associated language, sublanguage, country/region, calendar, and cultural conventions. This class also provides access to culture-specific instances of , , , and . These objects contain the information required for culture-specific operations, such as casing, formatting dates and numbers, and comparing strings. - To set the culture information value for the entire text string, use the method. + To set the culture information value for the entire text string, use the method. ]]> @@ -1163,7 +1163,7 @@ Minimum text width method. + This method sets the font family value for the entire text string. To set the font family value for a subset of the text string, use the method. ]]> @@ -1202,7 +1202,7 @@ Minimum text width method. + This method sets the font family value for the entire text string. To set the font family value for a subset of the text string, use the method. ]]> @@ -1245,7 +1245,7 @@ Minimum text width method. + To set the font family value for the entire text string, use the method. ]]> @@ -1288,7 +1288,7 @@ Minimum text width method. + To set the font family value for the entire text string, use the method. ]]> @@ -1336,7 +1336,7 @@ Minimum text width method. + This method sets the font size value for the entire text string. To set the font size value for a subset of the text string, use the method. ]]> @@ -1379,12 +1379,12 @@ Minimum text width method. + To set the font size value for the entire text string, use the method. ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -1435,9 +1435,9 @@ Minimum text width supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . You can also call to create a properly initialized . + The font stretch value refers to the degree to which a font is stretched on the screen. supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . You can also call to create a properly initialized . - This method sets the font stretch value for the entire text string. To set the font stretch value for a subset of the text string, use the method. + This method sets the font stretch value for the entire text string. To set the font stretch value for a subset of the text string, use the method. ]]> @@ -1482,9 +1482,9 @@ Minimum text width ## Remarks The font stretch value refers to the degree to which a font is stretched on the screen. - supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . You can also call to create a properly initialized . + supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . You can also call to create a properly initialized . - To set the font stretch value for the entire text string, use the method. + To set the font stretch value for the entire text string, use the method. ]]> @@ -1534,7 +1534,7 @@ Minimum text width ## Remarks supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . - This method sets the font style for the entire text string. To set the font style for a subset of the text string, use the method. + This method sets the font style for the entire text string. To set the font style for a subset of the text string, use the method. ]]> @@ -1579,12 +1579,12 @@ Minimum text width ## Remarks supports type conversion behavior such that static values of the class can be used to initialize and fill parameters that are type . - To set the font style for the entire text string, use the method. + To set the font style for the entire text string, use the method. ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -1637,7 +1637,7 @@ Minimum text width ## Remarks represents a combination of , , , and . supports multiple constructors, one of which constructs based on a typeface name, another of which takes discrete values for , , , and . - This method sets the font typeface for the entire text string. To set the font typeface for a subset of the text string, use the method. + This method sets the font typeface for the entire text string. To set the font typeface for a subset of the text string, use the method. ]]> @@ -1682,7 +1682,7 @@ Minimum text width ## Remarks represents a combination of , , , and . supports multiple constructors, one of which constructs based on a typeface name, another of which takes discrete values for , , , and . - To set the font typeface for the entire text string, use the method. + To set the font typeface for the entire text string, use the method. ]]> @@ -1778,7 +1778,7 @@ Minimum text width ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -1829,7 +1829,7 @@ Minimum text width method. + This method sets the foreground brush for the entire text string. To set the foreground brush for a subset of the text string, use the method. ]]> @@ -1872,12 +1872,12 @@ Minimum text width method. + To set the foreground brush for the entire text string, use the method. ## Examples - The following example creates a object and then applies several formatting styles to the text, including . + The following example creates a object and then applies several formatting styles to the text, including . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/FormattedText/Overview/Window1.xaml.cs" id="Snippetformattedtextsnippets1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/FormattedText/Overview/window1.xaml.vb" id="Snippetformattedtextsnippets1"::: @@ -1919,7 +1919,7 @@ Minimum text width will override any value provided for the property. + If the text lines exceed the number of elements in the array, the last value in the array is used for the remaining lines. Providing a valid array will override any value provided for the property. ]]> @@ -1967,7 +1967,7 @@ Minimum text width class specifies how numbers in text are to be displayed. This method sets the number substitution behavior for the entire text string. To set the number substitution behavior for a subset of the text string, use the method. + The class specifies how numbers in text are to be displayed. This method sets the number substitution behavior for the entire text string. To set the number substitution behavior for a subset of the text string, use the method. ]]> @@ -2010,7 +2010,7 @@ Minimum text width class specifies how numbers in text are to be displayed. To set the number substitution behavior for the entire text string, use the method. + The class specifies how numbers in text are to be displayed. To set the number substitution behavior for the entire text string, use the method. ]]> @@ -2065,7 +2065,7 @@ Minimum text width ![Diagram of text decoration locations](~/add/media/textdecoration01.gif "Diagram of text decoration locations") Example of text decoration types - This method sets the for the entire text string. To set the for a subset of the text string, use the method. + This method sets the for the entire text string. To set the for a subset of the text string, use the method. ]]> @@ -2115,7 +2115,7 @@ Example of text decoration types ![Diagram of text decoration locations](~/add/media/textdecoration01.gif "Diagram of text decoration locations") Example of text decoration types - To set the for the entire text string, use the method. + To set the for the entire text string, use the method. ]]> @@ -2258,7 +2258,7 @@ Example of text decoration types value. + For multi-line text, the longest line is used for the value. ]]> @@ -2294,7 +2294,7 @@ Example of text decoration types value. + For multi-line text, the longest line is used for the value. ]]> diff --git a/xml/System.Windows.Media/GeneralTransform.xml b/xml/System.Windows.Media/GeneralTransform.xml index b825516714d..d8cc899b295 100644 --- a/xml/System.Windows.Media/GeneralTransform.xml +++ b/xml/System.Windows.Media/GeneralTransform.xml @@ -34,11 +34,11 @@ Provides generalized transformation support for objects, such as points and rectangles. This is an abstract class. - @@ -104,13 +104,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -143,13 +143,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -214,15 +214,15 @@ - The format to use. - - -or- - + The format to use. + + -or- + A null reference ( in Visual Basic) to use the default format defined for the type of the implementation. - The provider to use to format the value. - - -or- - + The provider to use to format the value. + + -or- + A null reference ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. Formats the value of the current instance using the specified format. The value of the current instance in the specified format. @@ -403,11 +403,11 @@ if was transformed; otherwise, . - method, this method does not throw an exception if the transformation is unsuccessful. - + method, this method does not throw an exception if the transformation is unsuccessful. + ]]> diff --git a/xml/System.Windows.Media/GeneralTransformCollection.xml b/xml/System.Windows.Media/GeneralTransformCollection.xml index 7e2fbaa42b1..2a4198d3cf0 100644 --- a/xml/System.Windows.Media/GeneralTransformCollection.xml +++ b/xml/System.Windows.Media/GeneralTransformCollection.xml @@ -51,29 +51,29 @@ Represents an ordered collection of objects. - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as , shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreGeneralTransformObjectElements - - -``` - - -## XAML Values - *oneOrMoreGeneralTransformObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as , shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreGeneralTransformObjectElements + + +``` + + +## XAML Values + *oneOrMoreGeneralTransformObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -208,19 +208,19 @@ The to add to the end of the . Adds a object to the end of the . - , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -256,11 +256,11 @@ Removes all objects from the . - . - + . + ]]> The is read-only. @@ -295,13 +295,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -366,13 +366,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -444,11 +444,11 @@ if the collection contains ; otherwise . - - + + ]]> @@ -493,10 +493,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -764,21 +764,21 @@ The object to insert. Inserts a object into the specified index position within the . - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -817,21 +817,21 @@ Gets or sets the object at the specified index position. The object at the position. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -871,10 +871,10 @@ if was successfully deleted; otherwise . To be added. - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -947,11 +947,11 @@ if the is read-only; otherwise, . - instance is cast an interface. - + instance is cast an interface. + ]]> @@ -987,11 +987,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1031,11 +1031,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1071,11 +1071,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1110,11 +1110,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1150,11 +1150,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1193,11 +1193,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1237,11 +1237,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1280,11 +1280,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1324,11 +1324,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1364,11 +1364,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1404,11 +1404,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1453,11 +1453,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1495,11 +1495,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/GeneralTransformGroup.xml b/xml/System.Windows.Media/GeneralTransformGroup.xml index 15bd009289d..000a52ebb0e 100644 --- a/xml/System.Windows.Media/GeneralTransformGroup.xml +++ b/xml/System.Windows.Media/GeneralTransformGroup.xml @@ -179,7 +179,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -218,7 +218,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/Geometry.xml b/xml/System.Windows.Media/Geometry.xml index ddf4cf59f5a..4d0c67a1d5a 100644 --- a/xml/System.Windows.Media/Geometry.xml +++ b/xml/System.Windows.Media/Geometry.xml @@ -49,7 +49,7 @@ ## Remarks ## Geometry Compared to Shape - The class has a , , and other rendering properties that and its derived classes lack. The class is a and therefore participates in the layout system; its derived classes can be used as the content of any element that supports children. + The class has a , , and other rendering properties that and its derived classes lack. The class is a and therefore participates in the layout system; its derived classes can be used as the content of any element that supports children. The class, on the other hand, simply defines the geometry of a shape, and cannot render itself. Because of its simplicity, it has a wider range of uses. @@ -133,7 +133,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -172,7 +172,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -227,21 +227,21 @@ property) when combining geometries. To specify your own tolerance factor, use the method. + This method uses the default tolerance factor (described by the property) when combining geometries. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. - Careful thought should be involved when using to perform a union as it can be very CPU-expensive. In most cases, a or will work better. + Careful thought should be involved when using to perform a union as it can be very CPU-expensive. In most cases, a or will work better. - Use only when any of the following apply: + Use only when any of the following apply: - The geometric operation is not a union. - Either of the geometries has a value of and the geometries are self-intersecting (i.e. the actually matters). -- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . +- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . -- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. +- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. ]]> @@ -291,19 +291,19 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. - Careful thought should be involved when using to perform a union as it can be very CPU-expensive. In most cases, a or will work better. + Careful thought should be involved when using to perform a union as it can be very CPU-expensive. In most cases, a or will work better. - Use only when any of the following apply: + Use only when any of the following apply: - The geometric operation is not a union. - Either of the geometries has a value of and the geometries are self-intersecting (i.e. the actually matters). -- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . +- Time is not a concern, but space is (for instance, if the geometry is created once and then cached). Typically, produces smaller output than . -- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. +- The resulting geometry will be stroked or used in a path animation and does not provide the desired outline. ]]> @@ -388,7 +388,7 @@ property) is used when determining whether the current geometry contains the specified geometry. To specify your own margin of error, use the method. + The default margin of error (described by the property) is used when determining whether the current geometry contains the specified geometry. To specify your own margin of error, use the method. ]]> @@ -429,7 +429,7 @@ property) is used when determining whether the geometry contains the specified point. To specify your own tolerance factor, use the method. + The default tolerance factor (described by the property) is used when determining whether the geometry contains the specified point. To specify your own tolerance factor, use the method. ]]> @@ -474,7 +474,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -525,7 +525,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -574,9 +574,9 @@ property) is used when determining whether the current geometry contains the specified geometry. To specify your own tolerance factor, use the method. + The default tolerance factor (defined by the property) is used when determining whether the current geometry contains the specified geometry. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -620,7 +620,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -666,7 +666,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -714,7 +714,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -760,9 +760,9 @@ property) when processing the geometry. To specify your own tolerance factor, use the method. + This method uses the default tolerance factor (described by the property) when processing the geometry. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -810,7 +810,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -856,9 +856,9 @@ property) when processing the geometry. To specify your own tolerance factor, use the method. + This method uses the default tolerance factor (described by the property) when processing the geometry. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -906,7 +906,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -955,9 +955,9 @@ property) when processing the geometry. To specify your own tolerance factor, use the method. + This method uses the default tolerance factor (described by the property) when processing the geometry. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1001,7 +1001,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1050,7 +1050,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1100,7 +1100,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1320,9 +1320,9 @@ property) is used when determining whether the specified point is located in the geometry's stroke. To specify your own tolerance factor, use the overload. + The default tolerance factor (specified by the property) is used when determining whether the specified point is located in the geometry's stroke. To specify your own tolerance factor, use the overload. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1369,7 +1369,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1420,9 +1420,9 @@ property) is used when determining whether the specified geometry is located in the current geometry's stroke. To specify your own tolerance factor, use the method. + The default tolerance factor (defined by the property) is used when determining whether the specified geometry is located in the current geometry's stroke. To specify your own tolerance factor, use the method. - Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> @@ -1468,7 +1468,7 @@ methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. + Some methods (such as ) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor. ]]> diff --git a/xml/System.Windows.Media/GeometryCollection.xml b/xml/System.Windows.Media/GeometryCollection.xml index 60904a76b80..f9cb4a66b21 100644 --- a/xml/System.Windows.Media/GeometryCollection.xml +++ b/xml/System.Windows.Media/GeometryCollection.xml @@ -51,27 +51,27 @@ Represents a collection of objects. - is not itself a composite geometry, but is used by the class to store objects. - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreGeometryObjectElements - - -``` - - -## XAML Values - *oneOrMoreGeometryObjectElements* - One or more objects, declared using object element syntax. - + is not itself a composite geometry, but is used by the class to store objects. + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreGeometryObjectElements + + +``` + + +## XAML Values + *oneOrMoreGeometryObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -265,13 +265,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -336,13 +336,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -677,15 +677,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - and ending at the last . - - This method performs a linear search; therefore, the average execution time is proportional to the value of . That is, this method is an O(*n*) operation, where *n* is equal to . - - This method determines equality by calling . - + and ending at the last . + + This method performs a linear search; therefore, the average execution time is proportional to the value of . That is, this method is an O(*n*) operation, where *n* is equal to . + + This method determines equality by calling . + ]]> @@ -764,10 +764,10 @@ To be added. The attempt to modify the collection is invalid because the collection is frozen (its property is ). - is less than zero. - - -or- - + is less than zero. + + -or- + is equal to or greater than . @@ -875,11 +875,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -916,11 +916,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -961,11 +961,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1002,11 +1002,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1041,11 +1041,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1081,11 +1081,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1125,11 +1125,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1170,11 +1170,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1214,11 +1214,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1259,11 +1259,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1300,11 +1300,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1341,11 +1341,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1391,11 +1391,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1434,11 +1434,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/GeometryConverter.xml b/xml/System.Windows.Media/GeometryConverter.xml index 8eb19353c64..a6c9e1deb70 100644 --- a/xml/System.Windows.Media/GeometryConverter.xml +++ b/xml/System.Windows.Media/GeometryConverter.xml @@ -165,11 +165,11 @@ Converts the specified object to a . The created from converting . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/GeometryDrawing.xml b/xml/System.Windows.Media/GeometryDrawing.xml index 0001f8ce48e..16d72f37241 100644 --- a/xml/System.Windows.Media/GeometryDrawing.xml +++ b/xml/System.Windows.Media/GeometryDrawing.xml @@ -211,7 +211,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -250,7 +250,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/GeometryGroup.xml b/xml/System.Windows.Media/GeometryGroup.xml index 925ab6a3152..b990cee0ce1 100644 --- a/xml/System.Windows.Media/GeometryGroup.xml +++ b/xml/System.Windows.Media/GeometryGroup.xml @@ -34,17 +34,17 @@ , a , or by calling the static method . A creates a composite geometry from exactly two geometry objects. A , on the other hand, creates a composite geometry from any number of geometry objects. + Composite geometry objects can be created using a , a , or by calling the static method . A creates a composite geometry from exactly two geometry objects. A , on the other hand, creates a composite geometry from any number of geometry objects. - uses the property to specify how its geometry objects are combined. See [How to: Control the Fill of a Composite Shape](/dotnet/framework/wpf/graphics-multimedia/how-to-control-the-fill-of-a-composite-shape) for more information on using . + uses the property to specify how its geometry objects are combined. See [How to: Control the Fill of a Composite Shape](/dotnet/framework/wpf/graphics-multimedia/how-to-control-the-fill-of-a-composite-shape) for more information on using . - Geometries can be combined in several ways: using a , a , or the method of the class. + Geometries can be combined in several ways: using a , a , or the method of the class. - A creates a composite geometry from one or more objects. - A uses a specified boolean operation to combine the area described by two objects. -- The static method of the class behaves in exactly the same manner as the object. +- The static method of the class behaves in exactly the same manner as the object. It is worth noting that a is not itself a composite geometry, but is used by the class to store objects. @@ -182,7 +182,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -221,7 +221,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/GeometryHitTestParameters.xml b/xml/System.Windows.Media/GeometryHitTestParameters.xml index 1d0754585a1..64872ef9b10 100644 --- a/xml/System.Windows.Media/GeometryHitTestParameters.xml +++ b/xml/System.Windows.Media/GeometryHitTestParameters.xml @@ -37,7 +37,7 @@ ## Examples - The following example shows how to set up a hit test using for the method. The value that is passed to the `OnMouseDown` method is used to create a object in order to expand the range of the hit test. + The following example shows how to set up a hit test using for the method. The value that is passed to the `OnMouseDown` method is used to create a object in order to expand the range of the hit test. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/GeometryHitTest.cs" id="Snippethittestingoverviewsnippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/geometryhittest.vb" id="Snippethittestingoverviewsnippet10"::: @@ -81,7 +81,7 @@ Intersection between hit test geometry and target object for the method. A value is used to create a object to expand the range of the hit test over a wider display area. + The following example shows how to set up a hit test by using for the method. A value is used to create a object to expand the range of the hit test over a wider display area. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/GeometryHitTest.cs" id="Snippethittestingoverviewsnippet12"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/geometryhittest.vb" id="Snippethittestingoverviewsnippet12"::: diff --git a/xml/System.Windows.Media/GeometryHitTestResult.xml b/xml/System.Windows.Media/GeometryHitTestResult.xml index 9318c137b3a..5b6a739e826 100644 --- a/xml/System.Windows.Media/GeometryHitTestResult.xml +++ b/xml/System.Windows.Media/GeometryHitTestResult.xml @@ -71,7 +71,7 @@ object and use it as a return value for an overridden implementation of . + The following example shows how to create a object and use it as a return value for an overridden implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/GeometryHitTest.cs" id="Snippethittestingoverviewsnippet13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/geometryhittest.vb" id="Snippethittestingoverviewsnippet13"::: diff --git a/xml/System.Windows.Media/GlyphRun.xml b/xml/System.Windows.Media/GlyphRun.xml index a21eefffd98..4d1b2b92b2f 100644 --- a/xml/System.Windows.Media/GlyphRun.xml +++ b/xml/System.Windows.Media/GlyphRun.xml @@ -504,7 +504,7 @@ Various typographic qualities of two different glyph characters , to the corresponding character, represented by . + There is one entry per character in the list. Each value in the list gives the offset of the first glyph, represented by , to the corresponding character, represented by . Where multiple characters map to a single glyph, or to a glyph group that cannot be broken down to map exactly to individual characters, the entries for all the characters have the same value: the offset of the first glyph that represents this group of characters. @@ -618,7 +618,7 @@ Various typographic qualities of two different glyph characters is rendered on a device that has built-in support for the named device font, the should be rendered using a device specific mechanism for selecting that font, and by sending Unicode code points rather than glyph indices. When rendering onto a device that does not include built-in support for the named device font, should be ignored. + When a is rendered on a device that has built-in support for the named device font, the should be rendered using a device specific mechanism for selecting that font, and by sending Unicode code points rather than glyph indices. When rendering onto a device that does not include built-in support for the named device font, should be ignored. ]]> @@ -774,7 +774,7 @@ Various typographic qualities of two different glyph characters . + To retrieve the previous valid caret character hit, use . ]]> @@ -814,7 +814,7 @@ Various typographic qualities of two different glyph characters . + To retrieve the next valid caret character hit, use . ]]> @@ -1004,7 +1004,7 @@ Various typographic qualities of two different glyph characters is `true`, the glyphs that make up text characters are rotated 90° counter-clockwise, using vertical baseline positioning metrics. + If is `true`, the glyphs that make up text characters are rotated 90° counter-clockwise, using vertical baseline positioning metrics. ]]> diff --git a/xml/System.Windows.Media/GlyphRunDrawing.xml b/xml/System.Windows.Media/GlyphRunDrawing.xml index 1c24b318adb..641ce1e64b4 100644 --- a/xml/System.Windows.Media/GlyphRunDrawing.xml +++ b/xml/System.Windows.Media/GlyphRunDrawing.xml @@ -153,7 +153,7 @@ Various typographic qualities of two different glyph characters ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -192,7 +192,7 @@ Various typographic qualities of two different glyph characters ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/GlyphTypeface.xml b/xml/System.Windows.Media/GlyphTypeface.xml index 9e6a7ee8fc8..ef05136c99c 100644 --- a/xml/System.Windows.Media/GlyphTypeface.xml +++ b/xml/System.Windows.Media/GlyphTypeface.xml @@ -352,9 +352,9 @@ Metric values of glyph characters value is positive when the bottom edge of the black box is within the alignment rectangle defined by the advance width and font cell height. The font cell height is a horizontal dimension in vertical layout. + The value is positive when the bottom edge of the black box is within the alignment rectangle defined by the advance width and font cell height. The font cell height is a horizontal dimension in vertical layout. - The value is negative when the bottom edge of the black box overhangs the alignment rectangle. + The value is negative when the bottom edge of the black box overhangs the alignment rectangle. ]]> @@ -747,7 +747,7 @@ Metric values of glyph characters objects are considered equal if the properties are equal. + Two objects are considered equal if the properties are equal. ]]> @@ -1114,9 +1114,9 @@ Metric values of glyph characters value is positive when the left edge of the black box is within the alignment rectangle defined by the advance width and font cell height. + The value is positive when the left edge of the black box is within the alignment rectangle defined by the advance width and font cell height. - The value is negative when the left edge of the black box overhangs the alignment rectangle. + The value is negative when the left edge of the black box overhangs the alignment rectangle. ]]> @@ -1223,9 +1223,9 @@ Metric values of glyph characters value is positive when the trailing edge of the black box is within the alignment rectangle defined by the advance width and font cell height. + The value is positive when the trailing edge of the black box is within the alignment rectangle defined by the advance width and font cell height. - The value is negative when the right edge of the black box overhangs the alignment rectangle. + The value is negative when the right edge of the black box overhangs the alignment rectangle. ]]> @@ -1268,7 +1268,7 @@ Metric values of glyph characters value can be the font name, or any other text that the designer thinks is the best sample to display the font in. + The value can be the font name, or any other text that the designer thinks is the best sample to display the font in. ]]> @@ -1617,9 +1617,9 @@ Metric values of glyph characters value is positive when the top edge of the black box is within the alignment rectangle defined by the advance height and font cell height. The font cell height is a horizontal dimension in vertical layout. + The value is positive when the top edge of the black box is within the alignment rectangle defined by the advance height and font cell height. The font cell height is a horizontal dimension in vertical layout. - The value is negative when the top edge of the black box overhangs the alignment rectangle. + The value is negative when the top edge of the black box overhangs the alignment rectangle. ]]> @@ -1866,7 +1866,7 @@ Metric values of glyph characters - do not attempt to parse the value of the property. + Version strings vary significantly in format. To obtain the version as a numeric value, use the - do not attempt to parse the value of the property. ]]> diff --git a/xml/System.Windows.Media/GradientBrush.xml b/xml/System.Windows.Media/GradientBrush.xml index bacb9b1dd8c..e75496e2adf 100644 --- a/xml/System.Windows.Media/GradientBrush.xml +++ b/xml/System.Windows.Media/GradientBrush.xml @@ -146,7 +146,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -185,7 +185,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . Resource references, data bindings, and animations are not copied, but their current values are. @@ -389,7 +389,7 @@ ## Examples - The following example shows how to use the property to specify what coordinate system to use for the and of the gradient. + The following example shows how to use the property to specify what coordinate system to use for the and of the gradient. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/GradientBrushExamples_snip/XAML/GradientBrushMappingModeExample.xaml" id="Snippetgradientbrushmappingmodeexamplewholepage"::: @@ -455,7 +455,7 @@ and . The red line indicates the gradient space. A defines its gradient space with its and properties. A defines its gradient space with its , , and properties. + The following illustration shows the available spread methods and their effect on and . The red line indicates the gradient space. A defines its gradient space with its and properties. A defines its gradient space with its , , and properties. ![Different GradientSpread settings](~/add/media/img-mmgraphics-gradientspread.png "Different GradientSpread settings") Gradient spread methods @@ -471,7 +471,7 @@ Gradient spread methods ## Examples - The following example applies different settings to several and objects. + The following example applies different settings to several and objects. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/BrushesIntroduction_snip/XAML/GradientSpreadExample.xaml" id="Snippetgraphicsmmgradientspreadexamplewholepage"::: diff --git a/xml/System.Windows.Media/GradientSpreadMethod.xml b/xml/System.Windows.Media/GradientSpreadMethod.xml index 054c994b5ad..d95596d55c8 100644 --- a/xml/System.Windows.Media/GradientSpreadMethod.xml +++ b/xml/System.Windows.Media/GradientSpreadMethod.xml @@ -23,14 +23,14 @@ Specifies how to draw the gradient outside a gradient brush's gradient vector or space. - and . The red line indicates the gradient space. A defines its gradient space with its and properties. A defines its gradient space with its , , and properties. - - ![Different GradientSpread settings](~/add/media/img-mmgraphics-gradientspread.png "Different GradientSpread settings") -Gradient spread methods - + and . The red line indicates the gradient space. A defines its gradient space with its and properties. A defines its gradient space with its , , and properties. + + ![Different GradientSpread settings](~/add/media/img-mmgraphics-gradientspread.png "Different GradientSpread settings") +Gradient spread methods + ]]> diff --git a/xml/System.Windows.Media/GradientStop.xml b/xml/System.Windows.Media/GradientStop.xml index d43c90f19e4..4383cec5168 100644 --- a/xml/System.Windows.Media/GradientStop.xml +++ b/xml/System.Windows.Media/GradientStop.xml @@ -156,7 +156,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -195,7 +195,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/GradientStopCollection.xml b/xml/System.Windows.Media/GradientStopCollection.xml index bab052cdfe5..cd49d4d6e4d 100644 --- a/xml/System.Windows.Media/GradientStopCollection.xml +++ b/xml/System.Windows.Media/GradientStopCollection.xml @@ -54,31 +54,31 @@ Represents a collection of objects that can be individually accessed by index. - is used by the classes to store information. - - Except as noted, members of this class behave exactly as described by the , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreGradientStopObjectElements - - -``` - - -## XAML Values - *oneOrMoreGradientStopObjectElements* - One or more objects, declared using object element syntax. - + is used by the classes to store information. + + Except as noted, members of this class behave exactly as described by the , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreGradientStopObjectElements + + +``` + + +## XAML Values + *oneOrMoreGradientStopObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -217,19 +217,19 @@ The to add to the end of the . Adds a to the gradient stop collection. - , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -265,11 +265,11 @@ Removes all items from the gradient stop list. - . - + . + ]]> The is read-only. @@ -304,13 +304,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -375,13 +375,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -496,10 +496,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -535,11 +535,11 @@ Gets the number of items contained in a . The number of items in a . - method. - + method. + ]]> @@ -699,21 +699,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -789,21 +789,21 @@ The to insert. Inserts a at the specified position in the gradient stop list. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -842,21 +842,21 @@ Gets or sets the at the specified zero-based index. The at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -928,10 +928,10 @@ if was removed from the ; otherwise, . To be added. - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -1004,11 +1004,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1044,11 +1044,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1088,11 +1088,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1128,11 +1128,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1167,13 +1167,13 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - - Example - + instance is cast to an interface. + + Example + ]]> @@ -1209,13 +1209,13 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - - Example - + instance is cast to an interface. + + Example + ]]> @@ -1254,11 +1254,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1298,11 +1298,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1341,11 +1341,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1385,11 +1385,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1425,11 +1425,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1465,11 +1465,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1514,11 +1514,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1556,11 +1556,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1596,24 +1596,24 @@ - The specifying the format to use. - - -or- - + The specifying the format to use. + + -or- + ( in Visual Basic) to use the default format defined for the type of the implementation. - The to use to format the value. - - -or- - + The to use to format the value. + + -or- + ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. For a description of this member, see . A containing the value of the current instance in the specified format. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/GuidelineSet.xml b/xml/System.Windows.Media/GuidelineSet.xml index 873fc632299..52317c64539 100644 --- a/xml/System.Windows.Media/GuidelineSet.xml +++ b/xml/System.Windows.Media/GuidelineSet.xml @@ -127,7 +127,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -166,7 +166,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/HitTestFilterCallback.xml b/xml/System.Windows.Media/HitTestFilterCallback.xml index 8435809e311..2ddceb126dd 100644 --- a/xml/System.Windows.Media/HitTestFilterCallback.xml +++ b/xml/System.Windows.Media/HitTestFilterCallback.xml @@ -45,7 +45,7 @@ Pruning a visual tree ## Examples - The following example shows how to invoke by using a value. The corresponding hit test callback method is also defined. + The following example shows how to invoke by using a value. The corresponding hit test callback method is also defined. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet104"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet104"::: diff --git a/xml/System.Windows.Media/HitTestResult.xml b/xml/System.Windows.Media/HitTestResult.xml index 7e8d7d32349..3ecba2a3954 100644 --- a/xml/System.Windows.Media/HitTestResult.xml +++ b/xml/System.Windows.Media/HitTestResult.xml @@ -32,7 +32,7 @@ ## Examples - The following example shows how to retrieve the return value from the method. + The following example shows how to retrieve the return value from the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet100"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet100"::: diff --git a/xml/System.Windows.Media/HitTestResultCallback.xml b/xml/System.Windows.Media/HitTestResultCallback.xml index 52255579795..ddcba177473 100644 --- a/xml/System.Windows.Media/HitTestResultCallback.xml +++ b/xml/System.Windows.Media/HitTestResultCallback.xml @@ -31,19 +31,19 @@ Represents a callback that is used to customize hit testing. WPF invokes the to report hit test intersections to the user. A that represents the action resulting from the hit test. - value that determines whether to continue iterating through the visual tree for any other visual objects. - - - -## Examples - The following example shows how to invoke by using a value. The corresponding hit test callback method is also defined. - + value that determines whether to continue iterating through the visual tree for any other visual objects. + + + +## Examples + The following example shows how to invoke by using a value. The corresponding hit test callback method is also defined. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/Window1.xaml.cs" id="Snippet103"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet103"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet103"::: + ]]> diff --git a/xml/System.Windows.Media/HostVisual.xml b/xml/System.Windows.Media/HostVisual.xml index 012ccc353b9..001e0e0feab 100644 --- a/xml/System.Windows.Media/HostVisual.xml +++ b/xml/System.Windows.Media/HostVisual.xml @@ -91,11 +91,11 @@ Implements to supply base hit testing behavior (returning ). Returns a value of type . The property contains the visual that was hit. - never reports itself as being hit. To change this behavior, create a class derived from and override the methods. - + never reports itself as being hit. To change this behavior, create a class derived from and override the methods. + ]]> @@ -131,11 +131,11 @@ Implements to supply base hit testing behavior (returning ). Returns a value of type . The property contains the visual object that was hit. - never reports itself as being hit. To change this behavior, create a class derived from and override the methods. - + never reports itself as being hit. To change this behavior, create a class derived from and override the methods. + ]]> diff --git a/xml/System.Windows.Media/ImageBrush.xml b/xml/System.Windows.Media/ImageBrush.xml index 57538909767..53c8edf2293 100644 --- a/xml/System.Windows.Media/ImageBrush.xml +++ b/xml/System.Windows.Media/ImageBrush.xml @@ -144,7 +144,7 @@ An ImageBrush can paint shapes, controls, text, and more This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -185,7 +185,7 @@ An ImageBrush can paint shapes, controls, text, and more This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/ImageDrawing.xml b/xml/System.Windows.Media/ImageDrawing.xml index 6c61d3b86f2..12bb637745c 100644 --- a/xml/System.Windows.Media/ImageDrawing.xml +++ b/xml/System.Windows.Media/ImageDrawing.xml @@ -134,7 +134,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -173,7 +173,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/ImageMetadata.xml b/xml/System.Windows.Media/ImageMetadata.xml index 774d2003737..a4f15137601 100644 --- a/xml/System.Windows.Media/ImageMetadata.xml +++ b/xml/System.Windows.Media/ImageMetadata.xml @@ -54,13 +54,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media/ImageSource.xml b/xml/System.Windows.Media/ImageSource.xml index 41489a11f8f..93bfc47a5fc 100644 --- a/xml/System.Windows.Media/ImageSource.xml +++ b/xml/System.Windows.Media/ImageSource.xml @@ -73,13 +73,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -112,13 +112,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -247,15 +247,15 @@ - The format to use. - - -or- - + The format to use. + + -or- + A null reference ( in Visual Basic) to use the default format defined for the type of the implementation. - The provider to use to format the value. - - -or- - + The provider to use to format the value. + + -or- + A null reference ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. Formats the value of the current instance using the specified format. The value of the current instance in the specified format. diff --git a/xml/System.Windows.Media/Int32Collection.xml b/xml/System.Windows.Media/Int32Collection.xml index 292afb2f81a..b572b903122 100644 --- a/xml/System.Windows.Media/Int32Collection.xml +++ b/xml/System.Windows.Media/Int32Collection.xml @@ -67,7 +67,7 @@ , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. + Members of this class behave exactly as described by the , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -301,7 +301,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -372,7 +372,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -923,7 +923,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -963,7 +963,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media/LineGeometry.xml b/xml/System.Windows.Media/LineGeometry.xml index f8b78e3ad60..c1c240014f5 100644 --- a/xml/System.Windows.Media/LineGeometry.xml +++ b/xml/System.Windows.Media/LineGeometry.xml @@ -210,7 +210,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -249,7 +249,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/LineSegment.xml b/xml/System.Windows.Media/LineSegment.xml index 2a9a6cc4035..bd9e2f5f6cc 100644 --- a/xml/System.Windows.Media/LineSegment.xml +++ b/xml/System.Windows.Media/LineSegment.xml @@ -30,7 +30,7 @@ ## Remarks Use a object to create composite shapes using objects and other segments. - The class does not contain a property for the starting point of the line. The starting point of the line is the end point of the previous segment, or the of the if no other segments exist. + The class does not contain a property for the starting point of the line. The starting point of the line is the end point of the previous segment, or the of the if no other segments exist. **Freezable Features:** Because objects inherit from the class, they provide several special features: they can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features that are provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -147,7 +147,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -186,7 +186,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/LinearGradientBrush.xml b/xml/System.Windows.Media/LinearGradientBrush.xml index 04339801dfc..30f80ec55dc 100644 --- a/xml/System.Windows.Media/LinearGradientBrush.xml +++ b/xml/System.Windows.Media/LinearGradientBrush.xml @@ -28,9 +28,9 @@ paints an area with a linear gradient. A linear gradient defines a gradient along a line. The line's end points are defined by the and properties of the linear gradient. A brush paints its along this line. + A paints an area with a linear gradient. A linear gradient defines a gradient along a line. The line's end points are defined by the and properties of the linear gradient. A brush paints its along this line. - The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being painted, and its is (1,1), the lower-right corner of the area being painted. The colors in the resulting gradient are interpolated along the diagonal path. + The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being painted, and its is (1,1), the lower-right corner of the area being painted. The colors in the resulting gradient are interpolated along the diagonal path. The following illustration shows a diagonal gradient. A line was added to highlight the interpolation path of the gradient from the start point to the end point. @@ -65,7 +65,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -97,7 +97,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -133,7 +133,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -172,7 +172,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -212,7 +212,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -252,7 +252,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -294,7 +294,7 @@ A diagonal linear gradient with highlighted gradient stops of the brush is initialized to . + The of the brush is initialized to . ]]> @@ -333,7 +333,7 @@ A diagonal linear gradient with highlighted gradient stops ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -372,7 +372,7 @@ A diagonal linear gradient with highlighted gradient stops ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -438,9 +438,9 @@ A diagonal linear gradient with highlighted gradient stops paints a gradient along a line. The line's start and end points are defined by the and properties of the . + A paints a gradient along a line. The line's start and end points are defined by the and properties of the . - The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being filled, and its is (1,1), the lower-right corner of the area being filled. The colors in the resulting gradient are interpolated along the diagonal path. + The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being filled, and its is (1,1), the lower-right corner of the area being filled. The colors in the resulting gradient are interpolated along the diagonal path. The following image shows a diagonal gradient. The black line was added to highlight the interpolation path of the gradient from the start point to the end point. @@ -448,7 +448,7 @@ A diagonal linear gradient with highlighted gradient stops A diagonal linear gradient ## Specifying Relative or Absolute Values - Note that the property of a determines whether its is interpreted as a relative or absolute value. A of specifies that the value is relative to the size of the painted area. A of specifies that the value is expressed in device independent pixels. By default, the is set to , making the a relative value. + Note that the property of a determines whether its is interpreted as a relative or absolute value. A of specifies that the value is relative to the size of the painted area. A of specifies that the value is expressed in device independent pixels. By default, the is set to , making the a relative value. ## Dependency Property Information @@ -521,9 +521,9 @@ A diagonal linear gradient paints a gradient along a line. The line's start and end points are defined by the and properties of the . + A paints a gradient along a line. The line's start and end points are defined by the and properties of the . - The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being filled, and its is (1,1), the lower-right corner of the area being filled. The colors in the resulting gradient are interpolated along the diagonal path. + The default linear gradient is diagonal. In the default, the of a linear gradient is (0,0), the upper-left corner of the area being filled, and its is (1,1), the lower-right corner of the area being filled. The colors in the resulting gradient are interpolated along the diagonal path. The following image shows a diagonal gradient. The black line was added to highlight the interpolation path of the gradient from the start point to the end point. @@ -531,7 +531,7 @@ A diagonal linear gradient A diagonal linear gradient ## Specifying Relative or Absolute Values - Note that the property of a determines whether its is interpreted as a relative or absolute value. A of specifies that the value is relative to the size of the painted area. A of specifies that the value is expressed in device independent pixels. By default, the is set to , making the a relative value. + Note that the property of a determines whether its is interpreted as a relative or absolute value. A of specifies that the value is relative to the size of the painted area. A of specifies that the value is expressed in device independent pixels. By default, the is set to , making the a relative value. ## Dependency Property Information diff --git a/xml/System.Windows.Media/Matrix.xml b/xml/System.Windows.Media/Matrix.xml index 40aa919e4d2..3ff2144ea4e 100644 --- a/xml/System.Windows.Media/Matrix.xml +++ b/xml/System.Windows.Media/Matrix.xml @@ -52,15 +52,15 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| - The members in the last row, and , represent translation values. + The members in the last row, and , represent translation values. In methods and properties, the transformation matrix is usually specified as a vector with only six members, as follows: - (, , , , , ) + (, , , , , ) Although you can use a structure directly to translate individual points, or with a to transform objects, WPF also provides a set of classes that enable you to transform objects without working directly with matrices: , , , and . @@ -515,7 +515,7 @@ and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. + An identity matrix has a value of 1 in coefficients [1,1],[2,2],[3,3] and a value of 0 in the rest of the coefficients. This correlates to setting and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. | Column 1 | Column 2 | Column 3 | |----------|----------|----------| @@ -523,10 +523,10 @@ | 0 | 1 | 0 | | 0 | 0 | 1 | - For an identity matrix, the method returns the string "Identity" instead of the coefficients of the . + For an identity matrix, the method returns the string "Identity" instead of the coefficients of the . ## Examples - The following example shows how to retrieve the matrix. + The following example shows how to retrieve the matrix. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Matrix/Append/MatrixExample.cs" id="Snippetmatrixidentityexample_csharp"::: @@ -606,7 +606,7 @@ and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. + An identity matrix has a value of 1 in coefficients [1,1],[2,2],[3,3] and a value of 0 in the rest of the coefficients. This correlates to setting and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. | Column 1 | Column 2 | Column 3 | |----------|----------|----------| @@ -614,7 +614,7 @@ | 0 | 1 | 0 | | 0 | 0 | 1 | - For an identity matrix, the method returns the string "Identity", instead of the coefficients of the . + For an identity matrix, the method returns the string "Identity", instead of the coefficients of the . ]]> @@ -694,9 +694,9 @@ | Column 1 | Column 2 | Column 3 | |-----------------------------------------------|-----------------------------------------------|----------| -| | | 0 | -| | | 0 | -| | | 1 | +| | | 0 | +| | | 0 | +| | | 1 | ## Examples The following example shows how to multiply two structures and how to assign values to a when it is declared, and after the structure is declared. @@ -741,9 +741,9 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| ## Examples The following example shows how to multiply two structures and how to assign values to a when it is declared, and after the structure is declared. @@ -788,9 +788,9 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| ## Examples The following example shows how to multiply two structures and how to assign values to a when it is declared, and after the structure is declared. @@ -889,9 +889,9 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| ]]> @@ -933,9 +933,9 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| ]]> @@ -1605,7 +1605,7 @@ and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. + An identity matrix has a value of 1 in coefficients [1,1],[2,2],[3,3] and a value of 0 in the rest of the coefficients. This correlates to setting and to 1 and , , , and to 0. In an affine matrix, which is the implementation that Windows Presentation Foundation (WPF) uses for the structure, coefficients [3,1],[3,2],[3.3] are implied to always have the values 0,0,1 respectively. | Column 1 | Column 2 | Column 3 | |----------|----------|----------| @@ -1613,7 +1613,7 @@ | 0 | 1 | 0 | | 0 | 0 | 1 | - For an identity matrix, the method returns the string "Identity", instead of the coefficients of the . + For an identity matrix, the method returns the string "Identity", instead of the coefficients of the . ## Examples The following example shows how to turn a structure into an identity matrix. @@ -1826,7 +1826,7 @@ is an matrix, the string "Identity" is returned. + If this is an matrix, the string "Identity" is returned. ]]> diff --git a/xml/System.Windows.Media/MatrixConverter.xml b/xml/System.Windows.Media/MatrixConverter.xml index 188aede666f..b2a48f091ff 100644 --- a/xml/System.Windows.Media/MatrixConverter.xml +++ b/xml/System.Windows.Media/MatrixConverter.xml @@ -24,18 +24,18 @@ Converts instances of other types to and from a . - to create a from an attribute string; use a to create a XAML representation of a structure. - - - -## Examples - The following example uses a to convert a string into a . - - :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Matrix/Append/MatrixExample.cs" id="Snippetmatrixconverterexample_csharp"::: - + to create a from an attribute string; use a to create a XAML representation of a structure. + + + +## Examples + The following example uses a to convert a string into a . + + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/Matrix/Append/MatrixExample.cs" id="Snippetmatrixconverterexample_csharp"::: + ]]> @@ -179,11 +179,11 @@ Attempts to convert the specified object to a . The created from converting . - method. - + method. + ]]> The specified object is null or is a type that cannot be converted to a . @@ -226,11 +226,11 @@ Attempts to convert a to a specified type. The object created from converting this . - method. - + method. + ]]> The is null or is not a , or the is not a valid conversion type. diff --git a/xml/System.Windows.Media/MatrixTransform.xml b/xml/System.Windows.Media/MatrixTransform.xml index c3bbd2f770b..f094865ed84 100644 --- a/xml/System.Windows.Media/MatrixTransform.xml +++ b/xml/System.Windows.Media/MatrixTransform.xml @@ -38,15 +38,15 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| - The members in the last row, and , represent translation values. + The members in the last row, and , represent translation values. Methods and properties usually specify the transformation matrix as a vector that has only six members; the members are as follows: - (, , , , , ) + (, , , , , ) ## XAML Attribute Usage @@ -62,32 +62,32 @@ *m11* - The value at position (1, 1) of the transformation . + The value at position (1, 1) of the transformation . *m12* - The value at position (1, 2) of the transformation . + The value at position (1, 2) of the transformation . *m21* - The value at position (2, 1) of the transformation . + The value at position (2, 1) of the transformation . *m22* - The value at position (2, 2) of the transformation . + The value at position (2, 2) of the transformation . *offsetX* - The value at position (3, 1) of the transformation . + The value at position (3, 1) of the transformation . *offsetY* - The value at position (3, 2) of the transformation . + The value at position (3, 2) of the transformation . ]]> @@ -230,7 +230,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -269,7 +269,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/MediaPlayer.xml b/xml/System.Windows.Media/MediaPlayer.xml index 4d94350faaa..4879259279b 100644 --- a/xml/System.Windows.Media/MediaPlayer.xml +++ b/xml/System.Windows.Media/MediaPlayer.xml @@ -32,7 +32,7 @@ When distributing media with your application, you cannot use a media file as a project resource. In your project file, you must instead set the media type to `Content` and set `CopyToOutputDirectory` to `PreserveNewest` or `Always`. - can be used in two different modes, depending on what is driving the player: independent mode or clock mode. In independent mode, the is analogous to an image and the media opened through the method drives playback. In Clock mode, the can be thought of as a target for an animation, and thus it will have corresponding and entries in the Timing tree which controls playback. For more information on media modes, see the [Multimedia Overview](/dotnet/framework/wpf/graphics-multimedia/multimedia-overview). + can be used in two different modes, depending on what is driving the player: independent mode or clock mode. In independent mode, the is analogous to an image and the media opened through the method drives playback. In Clock mode, the can be thought of as a target for an animation, and thus it will have corresponding and entries in the Timing tree which controls playback. For more information on media modes, see the [Multimedia Overview](/dotnet/framework/wpf/graphics-multimedia/multimedia-overview). is different from a in that it is not a control that can be added directly to the user interface (UI) of an application. To display media loaded using , a or must be used. @@ -254,7 +254,7 @@ Setting this property tells the to be clock driven and will utilize the timing engine, placing the player in Clock mode. Any media that is playing is stopped and the associated with the new clock is opened. -When the player is in clock mode, seeking using , changing speed using , or calling the , , or methods will throw an . These operations are only available when the player is null. +When the player is in clock mode, seeking using , changing speed using , or calling the , , or methods will throw an . These operations are only available when the player is null. ]]> @@ -293,9 +293,9 @@ When the player is in clock mode, seeking using method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -334,9 +334,9 @@ When the player is in clock mode, seeking using method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -373,7 +373,7 @@ When the player is in clock mode, seeking using can be opened again by calling the method. + The can be opened again by calling the method. ]]> @@ -471,11 +471,11 @@ When the player is in clock mode, seeking using will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -724,7 +724,7 @@ When the player is in clock mode, seeking using cannot be determined until after has occurred. + cannot be determined until after has occurred. ]]> @@ -864,7 +864,7 @@ When the player is in clock mode, seeking using when a player has an associated will throw an . cannot be called while the timing engine drives media playback. + Calling when a player has an associated will throw an . cannot be called while the timing engine drives media playback. ]]> @@ -900,7 +900,7 @@ When the player is in clock mode, seeking using when a player has an associated will throw an . cannot be called while the timing engine drives media playback. + Calling when a player has an associated will throw an . cannot be called while the timing engine drives media playback. ]]> @@ -936,7 +936,7 @@ When the player is in clock mode, seeking using , setting will throw an . cannot be set while the timing engine drives media playback. + If the player has an associated , setting will throw an . cannot be set while the timing engine drives media playback. ## XAML Text Usage @@ -1076,7 +1076,7 @@ When the player is in clock mode, seeking using is read-only. This property gets the that is opened through the method or the associated with the . + is read-only. This property gets the that is opened through the method or the associated with the . ]]> @@ -1114,9 +1114,9 @@ When the player is in clock mode, seeking using , setting is not allowed. cannot be set while the timing engine drives media playback. + If the player has an associated , setting is not allowed. cannot be set while the timing engine drives media playback. - Audio playback is not guaranteed when is not `1`. + Audio playback is not guaranteed when is not `1`. ## XAML Text Usage @@ -1156,7 +1156,7 @@ When the player is in clock mode, seeking using when a player has an associated will throw an . cannot be called while the timing engine drives media playback. + Calling when a player has an associated will throw an . cannot be called while the timing engine drives media playback. ]]> diff --git a/xml/System.Windows.Media/MediaTimeline.xml b/xml/System.Windows.Media/MediaTimeline.xml index 7c40fe96596..24e1605f821 100644 --- a/xml/System.Windows.Media/MediaTimeline.xml +++ b/xml/System.Windows.Media/MediaTimeline.xml @@ -32,7 +32,7 @@ is a object which provides control over media timing in the same way that animation timeline objects control animations. For example, a has associated and properties can be used to specify when media begins and how long it plays. See [Animation Overview](/dotnet/framework/wpf/graphics-multimedia/animation-overview) for more information on animation timelines. + is a object which provides control over media timing in the same way that animation timeline objects control animations. For example, a has associated and properties can be used to specify when media begins and how long it plays. See [Animation Overview](/dotnet/framework/wpf/graphics-multimedia/animation-overview) for more information on animation timelines. There are two ways to associate a to a using a . @@ -40,7 +40,7 @@ 2. By explicitly creating a from a and assigning it to a . - If the of the is set to `Automatic` (default), the duration of is the natural duration of the media source. To find the natural duration of the media source programmatically, query the property of the . + If the of the is set to `Automatic` (default), the duration of is the natural duration of the media source. To find the natural duration of the media source programmatically, query the property of the . ]]> @@ -271,7 +271,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -310,9 +310,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -351,7 +351,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -390,9 +390,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -526,11 +526,11 @@ will fail when trying to freeze the object and will throw an . + When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Note that if these properties contain resource references or data bindings, will fail when trying to freeze the object and will throw an . - This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information, see . + For more information, see . ]]> @@ -569,9 +569,9 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. - For more information see . + For more information see . ]]> diff --git a/xml/System.Windows.Media/NumberSubstitution.xml b/xml/System.Windows.Media/NumberSubstitution.xml index 3244a0db715..4bcedf2f7bd 100644 --- a/xml/System.Windows.Media/NumberSubstitution.xml +++ b/xml/System.Windows.Media/NumberSubstitution.xml @@ -156,13 +156,13 @@ Example of the appearance of digits in different cultures ## Remarks The default value of the property is `null`, which is interpreted as the "en-us" (United States English) culture. - If is not set to , this property is ignored. + If is not set to , this property is ignored. This reference page represents two identically named but not entirely equivalent usages for the property: - You can set this property in code on a instance, as a common language runtime (CLR) property. In this usage, the property is not backed by a dependency property identifier, it is backed by a private field and does not act as a dependency property. -- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.CultureOverride**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . +- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.CultureOverride**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is one of the string-format values as explained in XAML Values. In code, the attached property usage is supported by and . ## XAML Attribute Usage @@ -258,7 +258,7 @@ Example of the appearance of digits in different cultures - You can set this property in code on a instance, as a common language runtime (CLR) property. In this usage, the property is not backed by a dependency property identifier, it is backed by a private field and does not act as a dependency property. -- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.CultureSource**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is a string representation of a value. In code, the attached property usage is supported by and . +- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.CultureSource**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is a string representation of a value. In code, the attached property usage is supported by and . ## XAML Attribute Usage @@ -341,11 +341,11 @@ Example of the appearance of digits in different cultures ## Remarks Two objects are equal if the following properties are equal: -- +- -- +- -- +- ]]> @@ -646,7 +646,7 @@ Example of the appearance of digits in different cultures - You can set this property in code on a instance, as a common language runtime (CLR) property. In this usage, the property is not backed by a dependency property identifier, it is backed by a private field and does not act as a dependency property. -- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.Substitution**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is a string representation of a value. In code, the attached property usage is supported by and . +- You can set this property as an attached property usage in XAML. The attached property usage is the reason why this property has a Dependency Property Information section, because the attached property is backed by a dependency property identifier. In XAML, the usage is `<`*object* **NumberSubstitution.Substitution**`="`*value*`".../>`, where *object* is an object element where the specified number substitution logic applies, and *value* is a string representation of a value. In code, the attached property usage is supported by and . ## XAML Attribute Usage diff --git a/xml/System.Windows.Media/PathFigure.xml b/xml/System.Windows.Media/PathFigure.xml index 4aaf08df274..90741e2a96f 100644 --- a/xml/System.Windows.Media/PathFigure.xml +++ b/xml/System.Windows.Media/PathFigure.xml @@ -173,7 +173,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -212,7 +212,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -450,7 +450,7 @@ ## Remarks If this property is set to `false`, then only the outline of the will be used, and its contained area will not contribute to the overall area of the . - One use of this property is to allow unfilled strokes in an otherwise filled , like the mouth in the left Smiley below. Setting the mouth's to `true` may produce the undesired effect of the mouth in the right Smiley. + One use of this property is to allow unfilled strokes in an otherwise filled , like the mouth in the left Smiley below. Setting the mouth's to `true` may produce the undesired effect of the mouth in the right Smiley. ![smiley path is filled](~/add/media/ref-mil-pathfigure-isfilled-smiley.PNG "smiley path is filled") IsFilled Example diff --git a/xml/System.Windows.Media/PathFigureCollection.xml b/xml/System.Windows.Media/PathFigureCollection.xml index d340b9c9ad3..9c84f4f9ed8 100644 --- a/xml/System.Windows.Media/PathFigureCollection.xml +++ b/xml/System.Windows.Media/PathFigureCollection.xml @@ -64,39 +64,39 @@ Represents a collection of objects that collectively make up the geometry of a . - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMorePathFigureObjectElements - - -``` - - -## XAML Attribute Usage - -``` - -``` - - -## XAML Values - *drawingCommands* - A space-delimited list of drawing commands, starting with a move-to command. For more information, see the [Path Markup Syntax](/dotnet/framework/wpf/graphics-multimedia/path-markup-syntax) overview. - - *oneOrMorePathFigureObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMorePathFigureObjectElements + + +``` + + +## XAML Attribute Usage + +``` + +``` + + +## XAML Values + *drawingCommands* + A space-delimited list of drawing commands, starting with a move-to command. For more information, see the [Path Markup Syntax](/dotnet/framework/wpf/graphics-multimedia/path-markup-syntax) overview. + + *oneOrMorePathFigureObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -231,21 +231,21 @@ The to add to the collection. Adds a to the end of the collection. - objects derive from , they are copied when they are used. Therefore, later, you might not be able to retrieve or remove the you added to the collection using the original object. The in the collection is a copy of the original and is considered a different than the one you added. - - This implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + objects derive from , they are copied when they are used. Therefore, later, you might not be able to retrieve or remove the you added to the collection using the original object. The in the collection is a copy of the original and is considered a different than the one you added. + + This implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -280,11 +280,11 @@ Removes all items from the . - . - + . + ]]> The is read-only. @@ -319,13 +319,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -390,13 +390,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -511,10 +511,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -744,13 +744,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The index of if found in the ; otherwise, -1. - and ending at the last . - - This method performs a linear search; therefore, the average execution time is proportional to the value of . That is, this method is an O(*n*) operation, where *n* is equal to . - + and ending at the last . + + This method performs a linear search; therefore, the average execution time is proportional to the value of . That is, this method is an O(*n*) operation, where *n* is equal to . + ]]> @@ -791,21 +791,21 @@ The object to insert in the collection. Inserts a into a specific location within the collection. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -844,21 +844,21 @@ Gets or sets the at the specified index position. The at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -931,10 +931,10 @@ if was removed from the ; otherwise, . To be added. - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -1007,11 +1007,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1047,11 +1047,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1091,11 +1091,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1131,11 +1131,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1170,11 +1170,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1210,11 +1210,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1253,11 +1253,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1297,11 +1297,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1340,11 +1340,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1384,11 +1384,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1424,11 +1424,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1464,11 +1464,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1513,11 +1513,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1555,11 +1555,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1595,24 +1595,24 @@ - The specifying the format to use. - - -or- - + The specifying the format to use. + + -or- + ( in Visual Basic) to use the default format defined for the type of the implementation. - The to use to format the value. - - -or- - + The to use to format the value. + + -or- + ( in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. For a description of this member, see . A containing the value of the current instance in the specified format. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/PathFigureCollectionConverter.xml b/xml/System.Windows.Media/PathFigureCollectionConverter.xml index 80a6d63eeef..4b7ddb8fe2d 100644 --- a/xml/System.Windows.Media/PathFigureCollectionConverter.xml +++ b/xml/System.Windows.Media/PathFigureCollectionConverter.xml @@ -164,11 +164,11 @@ Converts the specified object to a . The created from converting . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/PathGeometry.xml b/xml/System.Windows.Media/PathGeometry.xml index 527ac8059ab..84aa152d16a 100644 --- a/xml/System.Windows.Media/PathGeometry.xml +++ b/xml/System.Windows.Media/PathGeometry.xml @@ -36,7 +36,7 @@ ## Remarks Each object defines a collection of objects. Each of the objects is composed of one or more objects, such as and , which actually define their shape. - The filled area of the is defined by taking all of the contained objects that have their property set to `true` and applying the to determine the enclosed area. + The filled area of the is defined by taking all of the contained objects that have their property set to `true` and applying the to determine the enclosed area. ]]> @@ -268,7 +268,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -307,7 +307,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/PathSegment.xml b/xml/System.Windows.Media/PathSegment.xml index 01de1d39a18..a2fd94b7f21 100644 --- a/xml/System.Windows.Media/PathSegment.xml +++ b/xml/System.Windows.Media/PathSegment.xml @@ -83,7 +83,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -122,7 +122,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/PathSegmentCollection.xml b/xml/System.Windows.Media/PathSegmentCollection.xml index 64d81cfbc44..d0162b099a9 100644 --- a/xml/System.Windows.Media/PathSegmentCollection.xml +++ b/xml/System.Windows.Media/PathSegmentCollection.xml @@ -57,29 +57,29 @@ Represents a collection of objects that can be individually accessed by index. - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMorePathSegmentObjectElements - - -``` - - -## XAML Values - *oneOrMorePathSegmentObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMorePathSegmentObjectElements + + +``` + + +## XAML Values + *oneOrMorePathSegmentObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -215,21 +215,21 @@ The segment to add to the collection. Adds a to the end of the collection. - objects derive from , they are copied when they are used. Therefore, you might not be able to later retrieve or remove the you added to the collection using the original object; the in the collection is a copy of the original and is considered a different than the one you added. - - Unlike typical implementations of , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + objects derive from , they are copied when they are used. Therefore, you might not be able to later retrieve or remove the you added to the collection using the original object; the in the collection is a copy of the original and is considered a different than the one you added. + + Unlike typical implementations of , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -267,11 +267,11 @@ Clears the collection of all segments and resets to zero. - . - + . + ]]> The is read-only. @@ -306,13 +306,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -377,13 +377,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -498,10 +498,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -694,21 +694,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -786,21 +786,21 @@ The item to insert. Inserts a into this at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -839,21 +839,21 @@ Gets or sets the at the specified zero-based index. The item at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -893,10 +893,10 @@ if the specified is removed from the collection; otherwise, . To be added. - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -969,11 +969,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1009,11 +1009,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1053,11 +1053,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1094,11 +1094,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1133,11 +1133,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1173,11 +1173,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1217,11 +1217,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1262,11 +1262,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1306,11 +1306,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1351,11 +1351,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1392,11 +1392,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1432,11 +1432,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1481,11 +1481,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1524,11 +1524,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/Pen.xml b/xml/System.Windows.Media/Pen.xml index 13bf7170c62..9f1576fab51 100644 --- a/xml/System.Windows.Media/Pen.xml +++ b/xml/System.Windows.Media/Pen.xml @@ -210,7 +210,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -249,7 +249,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -480,7 +480,7 @@ ## Examples - The following example shows how to use the and properties to create a rounded end on one side of a stroke and a triangular end on the other side of the stroke. + The following example shows how to use the and properties to create a rounded end on one side of a stroke and a triangular end on the other side of the stroke. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/DrawingMiscSnippets_snip/XAML/PenStartEndLineCapExample.xaml" id="Snippetpenstartendlinecapwholepage"::: @@ -714,7 +714,7 @@ ## Examples - The following example shows how to use the and properties to create a rounded end on one side of a stroke and a triangular end on the other side of the stroke. + The following example shows how to use the and properties to create a rounded end on one side of a stroke and a triangular end on the other side of the stroke. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/DrawingMiscSnippets_snip/XAML/PenStartEndLineCapExample.xaml" id="Snippetpenstartendlinecapwholepage"::: diff --git a/xml/System.Windows.Media/PixelFormats.xml b/xml/System.Windows.Media/PixelFormats.xml index 87c03dfa8d2..96019296ff8 100644 --- a/xml/System.Windows.Media/PixelFormats.xml +++ b/xml/System.Windows.Media/PixelFormats.xml @@ -53,17 +53,17 @@ Gets the pixel format. is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 10 bits per pixel (BPP). The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -95,18 +95,18 @@ Gets the pixel format. is a sRGB format with 24 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP). The pixel format. - images, the monitor and controller must be capable of displaying at least 32,000 colors. - - -## XAML Attribute Usage - -``` - -``` - + images, the monitor and controller must be capable of displaying at least 32,000 colors. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -138,17 +138,17 @@ Gets the pixel format. is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP). The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -180,17 +180,17 @@ Gets the pixel format. is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5 bits per pixel (BPP). The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -222,17 +222,17 @@ Gets the pixel format. is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5, 6, and 5 bits per pixel (BPP) respectively. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -264,17 +264,17 @@ Gets the pixel format. is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP). The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -306,17 +306,17 @@ Gets the black and white pixel format which displays one bit of data per pixel as either black or white. The pixel format Black-and-White. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -348,18 +348,18 @@ Gets the pixel format which displays 32 bits per pixel (BPP) with each color channel (cyan, magenta, yellow, and black) allocated 8 bits per pixel (BPP). The CMYK32 pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -391,18 +391,18 @@ Gets the pixel format that is best suited for the particular operation. The best suited for the particular operation. - is technically not a pixel format but rather a way to access the pixel format best suited for a particular operation. This format is used for situations where the specific pixel format is not important. - - -## XAML Attribute Usage - -``` - -``` - + is technically not a pixel format but rather a way to access the pixel format best suited for a particular operation. This format is used for situations where the specific pixel format is not important. + + +## XAML Attribute Usage + +``` + +``` + ]]> The properties are accessed. @@ -435,17 +435,17 @@ Gets the pixel format which displays a 16 bits-per-pixel grayscale channel, allowing 65536 shades of gray. This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -477,17 +477,17 @@ Gets the pixel format which displays a 2 bits-per-pixel grayscale channel, allowing 4 shades of gray. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -519,17 +519,17 @@ Gets the pixel format. displays a 32 bits per pixel (BPP) grayscale channel, allowing over 4 billion shades of gray. This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -561,17 +561,17 @@ Gets the pixel format which displays a 4 bits-per-pixel grayscale channel, allowing 16 shades of gray. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -603,17 +603,17 @@ Gets the pixel format which displays an 8 bits-per-pixel grayscale channel, allowing 256 shades of gray. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -645,18 +645,18 @@ Gets the pixel format specifying a paletted bitmap with 2 colors. The pixel format which specifying a paletted bitmap with 2 colors. - pixel format has 2 colors available in the table. - - -## XAML Attribute Usage - -``` - -``` - + pixel format has 2 colors available in the table. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -688,18 +688,18 @@ Gets the pixel format specifying a paletted bitmap with 4 colors. The pixel format which specifying a paletted bitmap with 4 colors. - pixel format has 4 colors available in the table. - - -## XAML Attribute Usage - -``` - -``` - + pixel format has 4 colors available in the table. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -731,18 +731,18 @@ Gets the pixel format specifying a paletted bitmap with 16 colors. The pixel format which specifying a paletted bitmap with 16 colors. - pixel format has 16 colors available in the table. - - -## XAML Attribute Usage - -``` - -``` - + pixel format has 16 colors available in the table. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -774,18 +774,18 @@ Gets the pixel format specifying a paletted bitmap with 256 colors. The pixel format which specifying a paletted bitmap with 256 colors. - pixel format has 256 colors available in the table. - - -## XAML Attribute Usage - -``` - -``` - + pixel format has 256 colors available in the table. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -817,17 +817,17 @@ Gets the pixel format. is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -859,17 +859,17 @@ Gets the pixel format. is a ScRGB format with 128 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -901,17 +901,17 @@ Gets the pixel format. is a sRGB format with 64 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -943,17 +943,17 @@ Gets the pixel format. is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 BPP. This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -985,20 +985,20 @@ Gets the pixel format. is a sRGB format with 24 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 8 bits per pixel (BPP). The pixel format. - image is the same as a image, but the color channels (red, green, and blue) are in a different order. - - -## XAML Attribute Usage - -``` - -``` - + image is the same as a image, but the color channels (red, green, and blue) are in a different order. + + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -1030,17 +1030,17 @@ Gets the pixel format. is a sRGB format with 48 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -1072,17 +1072,17 @@ Gets the pixel format. is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 bits per pixel (BPP). This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> @@ -1114,17 +1114,17 @@ Gets the pixel format. is an sRGB format with 64 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0. The pixel format. - -## XAML Attribute Usage - -``` - -``` - + +## XAML Attribute Usage + +``` + +``` + ]]> diff --git a/xml/System.Windows.Media/PointCollection.xml b/xml/System.Windows.Media/PointCollection.xml index f952d2ea5d8..0eb329b6934 100644 --- a/xml/System.Windows.Media/PointCollection.xml +++ b/xml/System.Windows.Media/PointCollection.xml @@ -67,7 +67,7 @@ , , and documentation. + Except as noted, members of this class behave exactly as described by the , , and documentation. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -238,7 +238,7 @@ , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. ]]> @@ -327,7 +327,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -398,7 +398,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -755,7 +755,7 @@ , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. ]]> @@ -808,7 +808,7 @@ , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. ]]> @@ -971,7 +971,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1012,7 +1012,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media/PointCollectionConverter.xml b/xml/System.Windows.Media/PointCollectionConverter.xml index d38166febe8..8a29ceea1b3 100644 --- a/xml/System.Windows.Media/PointCollectionConverter.xml +++ b/xml/System.Windows.Media/PointCollectionConverter.xml @@ -164,11 +164,11 @@ Attempts to convert the specified object to a . The that is created from converting . - method. - + method. + ]]> The specified object is null or is a type that cannot be converted to a . @@ -211,11 +211,11 @@ Attempts to convert a to a specified type. The object that is created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/PointHitTestParameters.xml b/xml/System.Windows.Media/PointHitTestParameters.xml index 8fcfc0e3b31..a0f53d354b8 100644 --- a/xml/System.Windows.Media/PointHitTestParameters.xml +++ b/xml/System.Windows.Media/PointHitTestParameters.xml @@ -24,11 +24,11 @@ Specifies a as the parameter to be used for hit testing of a visual object. - class is for discrete coordinate hit testing, such as might be returned by a device. You can also hit test with a by creating a object. - + class is for discrete coordinate hit testing, such as might be returned by a device. You can also hit test with a by creating a object. + ]]> @@ -66,14 +66,14 @@ The parameter that is specified as the value. Initializes a new instance of the class, using a . - by using a value. - + by using a value. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet101"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet101"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet101"::: + ]]> @@ -111,14 +111,14 @@ Gets the against which to hit test. The against which to hit test. - value is simply returned as part of . - + value is simply returned as part of . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet107"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet107"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet107"::: + ]]> diff --git a/xml/System.Windows.Media/PointHitTestResult.xml b/xml/System.Windows.Media/PointHitTestResult.xml index 80acd2f7101..8b642d72239 100644 --- a/xml/System.Windows.Media/PointHitTestResult.xml +++ b/xml/System.Windows.Media/PointHitTestResult.xml @@ -32,7 +32,7 @@ ## Examples - The following example shows how to retrieve the return value from the method. + The following example shows how to retrieve the return value from the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet100"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet100"::: @@ -153,7 +153,7 @@ value could potentially represent multiple visual objects during a single hit test. The hit test callback method defines the actions you perform when a hit test is identified on a particular visual object in the visual tree. After you perform the actions, you return a value that determines whether to continue the enumeration of any other visual objects. The order of enumeration of returned visual objects is by z-order on the rendering plane. + The value could potentially represent multiple visual objects during a single hit test. The hit test callback method defines the actions you perform when a hit test is identified on a particular visual object in the visual tree. After you perform the actions, you return a value that determines whether to continue the enumeration of any other visual objects. The order of enumeration of returned visual objects is by z-order on the rendering plane. diff --git a/xml/System.Windows.Media/PolyBezierSegment.xml b/xml/System.Windows.Media/PolyBezierSegment.xml index 7dad3108537..277db68be46 100644 --- a/xml/System.Windows.Media/PolyBezierSegment.xml +++ b/xml/System.Windows.Media/PolyBezierSegment.xml @@ -153,7 +153,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -192,7 +192,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/PolyLineSegment.xml b/xml/System.Windows.Media/PolyLineSegment.xml index 25a1ec1b0e6..6d73b171272 100644 --- a/xml/System.Windows.Media/PolyLineSegment.xml +++ b/xml/System.Windows.Media/PolyLineSegment.xml @@ -152,7 +152,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -191,7 +191,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -257,7 +257,7 @@ of the to the first point in this collection. Lines are then drawn between each subsequent point specified in this collection. + A line is drawn from the end point of the previous segment or, if this is the first segment, from the of the to the first point in this collection. Lines are then drawn between each subsequent point specified in this collection. ## Dependency Property Information diff --git a/xml/System.Windows.Media/PolyQuadraticBezierSegment.xml b/xml/System.Windows.Media/PolyQuadraticBezierSegment.xml index 9c1d2735caa..fa0249b3d8a 100644 --- a/xml/System.Windows.Media/PolyQuadraticBezierSegment.xml +++ b/xml/System.Windows.Media/PolyQuadraticBezierSegment.xml @@ -150,7 +150,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -189,7 +189,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/QuadraticBezierSegment.xml b/xml/System.Windows.Media/QuadraticBezierSegment.xml index aee9d383e08..d7a8afd27f5 100644 --- a/xml/System.Windows.Media/QuadraticBezierSegment.xml +++ b/xml/System.Windows.Media/QuadraticBezierSegment.xml @@ -30,7 +30,7 @@ ## Remarks Use a object to create composite shapes using objects and other segments. - The class does not contain a property for the starting point of the line. The starting point of the line is the end point of the previous segment, or the of the if no other segments exist. + The class does not contain a property for the starting point of the line. The starting point of the line is the end point of the previous segment, or the of the if no other segments exist. ## Freezable Features Because objects inherit from the class, they provide several special features: they can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features that are provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -148,7 +148,7 @@ This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -189,7 +189,7 @@ This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/RadialGradientBrush.xml b/xml/System.Windows.Media/RadialGradientBrush.xml index 9d0817b346d..12c72b141e6 100644 --- a/xml/System.Windows.Media/RadialGradientBrush.xml +++ b/xml/System.Windows.Media/RadialGradientBrush.xml @@ -25,22 +25,22 @@ Paints an area with a radial gradient. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient. - is similar in programming model to the . However, the linear gradient has a start and an end point to define the gradient vector, while the radial gradient has a circle, along with a focal point, to define the gradient behavior. The circle defines the end point of the gradient. In other words, a gradient stop at 1.0 defines the color at the circle's circumference. The focal point defines the center of the gradient. A gradient stop at 0.0 defines the color at the focal point. - - The following image shows a rectangle filled with a radial gradient. The radial gradient that goes from white to gray. The outside circle represents the gradient circle while the red dot denotes the focal point. This gradient has its set to . - - ![A radial gradient with highlighted components](~/add/media/art-radialgradientfocalpoint.jpg "A radial gradient with highlighted components") -Radial gradient with a highlighted focal point - + is similar in programming model to the . However, the linear gradient has a start and an end point to define the gradient vector, while the radial gradient has a circle, along with a focal point, to define the gradient behavior. The circle defines the end point of the gradient. In other words, a gradient stop at 1.0 defines the color at the circle's circumference. The focal point defines the center of the gradient. A gradient stop at 0.0 defines the color at the focal point. + + The following image shows a rectangle filled with a radial gradient. The radial gradient that goes from white to gray. The outside circle represents the gradient circle while the red dot denotes the focal point. This gradient has its set to . + + ![A radial gradient with highlighted components](~/add/media/art-radialgradientfocalpoint.jpg "A radial gradient with highlighted components") +Radial gradient with a highlighted focal point + > [!NOTE] -> objects are rendered using hardware acceleration on 2 systems. For more information about hardware tiers, see [Graphics Rendering Tiers](/dotnet/framework/wpf/advanced/graphics-rendering-tiers). - -## Freezable Features - Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - +> objects are rendered using hardware acceleration on 2 systems. For more information about hardware tiers, see [Graphics Rendering Tiers](/dotnet/framework/wpf/advanced/graphics-rendering-tiers). + +## Freezable Features + Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + ]]> @@ -169,11 +169,11 @@ Radial gradient with a highlighted focal point Gets or sets the center of the outermost circle of the radial gradient. The two-dimensional point located at the center of the radial gradient. - @@ -237,13 +237,13 @@ Radial gradient with a highlighted focal point Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -276,13 +276,13 @@ Radial gradient with a highlighted focal point Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> diff --git a/xml/System.Windows.Media/RectangleGeometry.xml b/xml/System.Windows.Media/RectangleGeometry.xml index 19229ca0d99..7ebf500db79 100644 --- a/xml/System.Windows.Media/RectangleGeometry.xml +++ b/xml/System.Windows.Media/RectangleGeometry.xml @@ -227,7 +227,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -266,7 +266,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -435,7 +435,7 @@ and properties must be non-zero. + For the rectangle to have rounded corners, both the and properties must be non-zero. ## Dependency Property Information @@ -508,7 +508,7 @@ and properties must be non-zero. + For the rectangle to have rounded corners, both the and properties must be non-zero. ## Dependency Property Information diff --git a/xml/System.Windows.Media/RenderCapability.xml b/xml/System.Windows.Media/RenderCapability.xml index 6228a18e200..a1523f9d3e7 100644 --- a/xml/System.Windows.Media/RenderCapability.xml +++ b/xml/System.Windows.Media/RenderCapability.xml @@ -82,7 +82,7 @@ method returns `true` if the pixel shader version is supported by the current version of WPF, and if an using the specified major/minor version can run on the GPU. + The method returns `true` if the pixel shader version is supported by the current version of WPF, and if an using the specified major/minor version can run on the GPU. ]]> @@ -204,7 +204,7 @@ returns the minimum size among them. + If there are multiple devices, returns the minimum size among them. ]]> diff --git a/xml/System.Windows.Media/RenderOptions.xml b/xml/System.Windows.Media/RenderOptions.xml index 73a671a48c1..f0ff35e997a 100644 --- a/xml/System.Windows.Media/RenderOptions.xml +++ b/xml/System.Windows.Media/RenderOptions.xml @@ -64,7 +64,7 @@ When animating the scale of any bitmap, the default high-quality image re-sampling algorithm can sometimes consume sufficient system resources to cause frame rate degradation, effectively causing animations to stutter. By setting the property to , you can create a smoother animation when scaling a bitmap. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Dependency Property Information @@ -137,11 +137,11 @@ By default, WPF does not cache the rendered contents of and objects. In static scenarios, where neither the contents nor the use of the brush in the scene is changing, not caching the content provides a benefit because it conserves video memory. When a brush with static content is used in a non-static way, the default behavior of WPF is to re-render all the content of the brush every frame, even though the content is unchanging. For example, this will happen when a static or is mapped to the surface of a rotating 3D object. Re-rendering the static content can have a negative impact on performance. - By setting the attached property on the brush to , you can increase performance by using cached versions of the tiled brush objects. + By setting the attached property on the brush to , you can increase performance by using cached versions of the tiled brush objects. - The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. + The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Dependency Property Information @@ -222,11 +222,11 @@ By default, WPF does not cache the rendered contents of and objects. In static scenarios, where neither the contents nor the use of the brush in the scene is changing, not caching the content provides a benefit because it conserves video memory. When a brush with static content is used in a non-static way the default behavior of WPF is to re-render all the content of the brush every frame, even though the content is unchanging. For example, this will happen when a static or is mapped to the surface of a rotating 3D object. Re-rendering the static content can have a negative impact on performance. - By setting the attached property on the brush to , you can increase performance by using cached versions of the tiled brush objects. + By setting the attached property on the brush to , you can increase performance by using cached versions of the tiled brush objects. - The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 0.5, the cache for the needs to be regenerated only when its size is reduced to less than one half the size of the current cache. + The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 0.5, the cache for the needs to be regenerated only when its size is reduced to less than one half the size of the current cache. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Dependency Property Information @@ -307,11 +307,11 @@ By default, WPF does not cache the rendered contents of and objects. In static scenarios, where neither the contents nor the use of the brush in the scene is changing, not caching provides a benefit because it conserves video memory. When a brush with static content is used in a non-static way, the default behavior of WPF is to re-render all the content of the brush every frame, even though the content is unchanging. For example, this will happen when a static or is mapped to the surface of a rotating 3D object. Re-rendering the static content can have a negative impact on performance. - By setting the attached property of the brush to , you can increase performance by using cached versions of the tiled brush objects. + By setting the attached property of the brush to , you can increase performance by using cached versions of the tiled brush objects. - The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. + The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Dependency Property Information @@ -388,34 +388,34 @@ attached property to indicate that text can be rendered with ClearType in a specific part of the visual tree. + Use the attached property to indicate that text can be rendered with ClearType in a specific part of the visual tree. - ClearType text does not display correctly on a background that is not fully opaque. Intermediate render targets, such as , , , , , and , can introduce backgrounds that are not fully opaque. WPF disables ClearType when it detects that the buffer into which text is drawn could have a transparent background. + ClearType text does not display correctly on a background that is not fully opaque. Intermediate render targets, such as , , , , , and , can introduce backgrounds that are not fully opaque. WPF disables ClearType when it detects that the buffer into which text is drawn could have a transparent background. - Set the property to to indicate that a subtree is safe for ClearType text rendering. Do this only when you can be certain that the text is rendering to a fully opaque background. When an element in the subtree introduces transparency, you can enable ClearType; however, rendering issues may occur. If a portion of the subtree introduces more intermediate rendering targets, you must set again on the children of that subtree. + Set the property to to indicate that a subtree is safe for ClearType text rendering. Do this only when you can be certain that the text is rendering to a fully opaque background. When an element in the subtree introduces transparency, you can enable ClearType; however, rendering issues may occur. If a portion of the subtree introduces more intermediate rendering targets, you must set again on the children of that subtree. The following list shows how to make sure that text to be rendered with ClearType appears correctly. -- Do not introduce intermediate render targets between and the text to be rendered with ClearType. +- Do not introduce intermediate render targets between and the text to be rendered with ClearType. - Assign an opaque background that is as close as possible in the visual tree to the text. -- Be aware that re-enables ClearType for a subtree; however, it does not force ClearType rendering. +- Be aware that re-enables ClearType for a subtree; however, it does not force ClearType rendering. -- Be aware that does not override your system settings or settings. +- Be aware that does not override your system settings or settings. > [!NOTE] -> The attached property does not affect the control; however, it does work with the control. +> The attached property does not affect the control; however, it does work with the control. > [!NOTE] -> On many controls, the attached property has no effect unless you set an opaque background behind the text. +> On many controls, the attached property has no effect unless you set an opaque background behind the text. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Examples - The following example shows how the property affects different branches of the visual tree. In the first text block control, text is rendered with ClearType because the text block inherits the setting from the main window. In the second text block, ClearType is not used because the parent element's property is set. In the third text block, is used, but rendering issues may occur. + The following example shows how the property affects different branches of the visual tree. In the first text block control, text is rendered with ClearType because the text block inherits the setting from the main window. In the second text block, ClearType is not used because the parent element's property is set. In the third text block, is used, but rendering issues may occur. ```xaml attached property to improve rendering performance by specifying that a visual object should be rendered with aliased edges. Text objects are always displayed with anti-aliasing, and are unaffected by setting the edge mode value. When you set the edge mode value of a visual object, all the descendant drawing primitives of the visual object are set to the same edge mode value. + Use the attached property to improve rendering performance by specifying that a visual object should be rendered with aliased edges. Text objects are always displayed with anti-aliasing, and are unaffected by setting the edge mode value. When you set the edge mode value of a visual object, all the descendant drawing primitives of the visual object are set to the same edge mode value. - To access this property in code, use the and methods. + To access this property in code, use the and methods. ## Dependency Property Information @@ -881,15 +881,15 @@ During application startup, if your application detects rendering issues, such as slow frame rates, you can set the rendering mode to software only. Also, you may want to enable the user setting while the application is running. - The preference overrides the setting. The precedence order for software rendering is: + The preference overrides the setting. The precedence order for software rendering is: 1. DisableHWAcceleration registry key -2. +2. -3. (per-target) +3. (per-target) - **Note** specifies a preference and does not necessarily change the actual rendering mode. Other parts of the system may override this preference and force the system into software rendering. + **Note** specifies a preference and does not necessarily change the actual rendering mode. Other parts of the system may override this preference and force the system into software rendering. ]]> @@ -931,7 +931,7 @@ method on a or descendant that is animating a bitmap. + Use the method on a or descendant that is animating a bitmap. When animating the scale of any bitmap, the default high-quality image re-sampling algorithm can sometimes consume sufficient system resources to cause frame rate degradation, effectively causing animations to stutter. By setting the property of the object to , you can create a smoother animation when scaling a bitmap. @@ -984,7 +984,7 @@ attached property in code. + Use this method to set the attached property in code. @@ -1036,7 +1036,7 @@ attached property in code. + Use this method to set the attached property in code. @@ -1090,11 +1090,11 @@ ## Remarks By default, WPF does not cache the rendered contents of and objects. In static scenarios, where neither the contents nor the use of the brush in the scene is changing, not caching provides a benefit because it conserves video memory. When a brush with static content is used in a non-static way, the default behavior of WPF is to re-render all the content of the brush every frame, even though the content is unchanging. For example, this will happen when a static or is mapped to the surface of a rotating 3D object. Re-rendering the static content can have a negative impact on performance. - By setting the attached property of the brush to , you can increase performance by using cached versions of the tiled brush objects. + By setting the attached property of the brush to , you can increase performance by using cached versions of the tiled brush objects. - The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. + The and property values are relative-size values that determine when the object should be regenerated because of changes in scale. For example, when the property is set to 2.0, the cache for the needs to be regenerated only when its size exceeds two times the size of the current cache. - Use this method to set the attached property in code. + Use this method to set the attached property in code. @@ -1185,7 +1185,7 @@ ## Examples - The following example shows how to use the method to set the edge mode for a visual object to . + The following example shows how to use the method to set the edge mode for a visual object to . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Snippets.cs" id="Snippetsetedgemode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/snippets.vb" id="Snippetsetedgemode"::: diff --git a/xml/System.Windows.Media/RequestCachePolicyConverter.xml b/xml/System.Windows.Media/RequestCachePolicyConverter.xml index 8662269bc83..b0a21f81e64 100644 --- a/xml/System.Windows.Media/RequestCachePolicyConverter.xml +++ b/xml/System.Windows.Media/RequestCachePolicyConverter.xml @@ -24,11 +24,11 @@ Parses a . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -62,11 +62,11 @@ Initializes a new instance of the class. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -105,11 +105,11 @@ if this converter can perform the conversion; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -148,11 +148,11 @@ if this converter can perform the conversion; otherwise, . - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -192,11 +192,11 @@ Converts the specified object to a object. An object that represents the converted value. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -246,11 +246,11 @@ Converts this object to the specified type. The object that is constructed from the conversion. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Windows.Media/RotateTransform.xml b/xml/System.Windows.Media/RotateTransform.xml index 288c2a934bc..6085b409d53 100644 --- a/xml/System.Windows.Media/RotateTransform.xml +++ b/xml/System.Windows.Media/RotateTransform.xml @@ -28,9 +28,9 @@ rotates an object by a specified about the point , . + A rotates an object by a specified about the point , . - When you use a , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. + When you use a , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -172,7 +172,7 @@ , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. + When you use a , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. ## Dependency Property Information @@ -244,7 +244,7 @@ , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. + When you use a , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. ## Dependency Property Information @@ -316,7 +316,7 @@ , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. + When you use a , realize that the transformation rotates the coordinate system for a particular object about the point (0, 0). Therefore, depending on the position of the object, it might not rotate in place (around its center). For example, if an object is positioned 200 units from 0 along the x-axis, a rotation of 30 degrees can swing the object 30 degrees along a circle that has a radius of 200, which is drawn around the origin. To rotate an object in place, set the and of the to the center of the object to rotate. ## Dependency Property Information @@ -359,7 +359,7 @@ dependency property. + The identifier for the dependency property. ]]> @@ -400,7 +400,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -439,7 +439,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/ScaleTransform.xml b/xml/System.Windows.Media/ScaleTransform.xml index 4a68feb3c09..f47198bd315 100644 --- a/xml/System.Windows.Media/ScaleTransform.xml +++ b/xml/System.Windows.Media/ScaleTransform.xml @@ -28,7 +28,7 @@ to stretch or shrink an object horizontally or vertically. The property specifies by how much to stretch or shrink an object along the x-axis, and the property specifies by how much to stretch or shrink an object along the y-axis. Scale operations are centered on the point specified by the and properties. + Use a to stretch or shrink an object horizontally or vertically. The property specifies by how much to stretch or shrink an object along the x-axis, and the property specifies by how much to stretch or shrink an object along the y-axis. Scale operations are centered on the point specified by the and properties. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -323,7 +323,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -362,7 +362,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/SkewTransform.xml b/xml/System.Windows.Media/SkewTransform.xml index f869cc27278..02c2059db95 100644 --- a/xml/System.Windows.Media/SkewTransform.xml +++ b/xml/System.Windows.Media/SkewTransform.xml @@ -166,7 +166,7 @@ and properties to the object's center point. + To skew an object in place, set the and properties to the object's center point. ## Dependency Property Information @@ -238,7 +238,7 @@ and properties to the object's center point. + To skew an object in place, set the and properties to the object's center point. ## Dependency Property Information @@ -310,7 +310,7 @@ and properties to the object's center point. + To skew an object in place, set the and properties to the object's center point. ## Dependency Property Information @@ -382,7 +382,7 @@ and properties to the object's center point. + To skew an object in place, set the and properties to the object's center point. ## Dependency Property Information @@ -459,7 +459,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -498,7 +498,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/SolidColorBrush.xml b/xml/System.Windows.Media/SolidColorBrush.xml index 2769f8275da..678777dd856 100644 --- a/xml/System.Windows.Media/SolidColorBrush.xml +++ b/xml/System.Windows.Media/SolidColorBrush.xml @@ -28,7 +28,7 @@ class provides a set of commonly used objects, such as and . + For convenience, the class provides a set of commonly used objects, such as and . **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -54,39 +54,39 @@ ## XAML Values *predefinedBrushName* - The name of a brush defined by the class, such as or . + The name of a brush defined by the class, such as or . *rgb* - A three-digit hexadecimal number that describes this brush's . The first digit specifies the color's value, the second digit specifies the value, and the third digit specifies the value. For example, `00F`. + A three-digit hexadecimal number that describes this brush's . The first digit specifies the color's value, the second digit specifies the value, and the third digit specifies the value. For example, `00F`. *argb* - A four-digit hexadecimal number that describes this brush's . The first digit specifies the color's value, the second digit specifies its value, the next digit specifies the value, and the final digit specifies its value. For example, `F00F`. + A four-digit hexadecimal number that describes this brush's . The first digit specifies the color's value, the second digit specifies its value, the next digit specifies the value, and the final digit specifies its value. For example, `F00F`. *rrggbb* - A six-digit hexadecimal number that describes this brush's . The first two digits specify the color's value, the next two specify its value, and the final two specify its value. For example, `0000FF`. + A six-digit hexadecimal number that describes this brush's . The first two digits specify the color's value, the next two specify its value, and the final two specify its value. For example, `0000FF`. *aarrggbb* - An eight-digit hexadecimal number that describes this brush's . The first two digits specify the color's value, the next two specify its value, the next two specify its value, and the final two specify its value. For example, `FF0000FF`. + An eight-digit hexadecimal number that describes this brush's . The first two digits specify the color's value, the next two specify its value, the next two specify its value, and the final two specify its value. For example, `FF0000FF`. *scA* - The value of this brush's . + The value of this brush's . *scR* - The value of this brush's . + The value of this brush's . *scG* - The value of this brush's . + The value of this brush's . *scB* - The value of this brush's . + The value of this brush's . *profileUri* @@ -204,7 +204,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -243,7 +243,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/StreamGeometry.xml b/xml/System.Windows.Media/StreamGeometry.xml index 65b6f915774..90288a56094 100644 --- a/xml/System.Windows.Media/StreamGeometry.xml +++ b/xml/System.Windows.Media/StreamGeometry.xml @@ -180,7 +180,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -251,7 +251,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/StreamGeometryContext.xml b/xml/System.Windows.Media/StreamGeometryContext.xml index c8d0c5df921..4506a448e44 100644 --- a/xml/System.Windows.Media/StreamGeometryContext.xml +++ b/xml/System.Windows.Media/StreamGeometryContext.xml @@ -77,21 +77,21 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws an arc to the specified point. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw an arc using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw an arc using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryArcToExample.cs" id="Snippetstreamgeometryarctoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometryarctoexample.vb" id="Snippetstreamgeometryarctoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometryarctoexample.vb" id="Snippetstreamgeometryarctoexamplewholepage"::: + ]]> @@ -136,13 +136,13 @@ to close the figure; otherwise, . For example, if two connecting lines are drawn, and is set to , the drawing will just be of two lines but if is set to , the two lines will be closed to create a triangle. Specifies the starting point for a new figure. - . - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - + . + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + ]]> @@ -187,23 +187,23 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws a Bezier curve to the specified point. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw a Bezier curve using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw a Bezier curve using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryBezierToExample.cs" id="Snippetstreamgeometrybeziertoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrybeziertoexample.vb" id="Snippetstreamgeometrybeziertoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrybeziertoexample.vb" id="Snippetstreamgeometrybeziertoexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. @@ -246,11 +246,11 @@ Closes this context and flushes its content so that it can be rendered. - This context has already been closed or disposed. @@ -292,21 +292,21 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws a straight line to the specified . - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw a triangle using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw a triangle using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryTriangleExample.cs" id="Snippetstreamgeometrytriangleexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrytriangleexample.vb" id="Snippetstreamgeometrytriangleexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrytriangleexample.vb" id="Snippetstreamgeometrytriangleexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. @@ -349,23 +349,23 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws one or more connected Bezier curves. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw multiple connected Bezier curves using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw multiple connected Bezier curves using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryPolyBezierToExample.cs" id="Snippetstreamgeometrypolybeziertoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolybeziertoexample.vb" id="Snippetstreamgeometrypolybeziertoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolybeziertoexample.vb" id="Snippetstreamgeometrypolybeziertoexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. @@ -411,21 +411,21 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws one or more connected straight lines. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw a triangle using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw a triangle using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryPolyLineToExample.cs" id="Snippetstreamgeometrypolylinetoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolylinetoexample.vb" id="Snippetstreamgeometrypolylinetoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolylinetoexample.vb" id="Snippetstreamgeometrypolylinetoexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. @@ -468,21 +468,21 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws one or more connected quadratic Bezier curves. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw multiple connected quadratic Bezier curves using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw multiple connected quadratic Bezier curves using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryPolyQuadraticBezierToExample.cs" id="Snippetstreamgeometrypolyquadraticbeziertoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolyquadraticbeziertoexample.vb" id="Snippetstreamgeometrypolyquadraticbeziertoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometrypolyquadraticbeziertoexample.vb" id="Snippetstreamgeometrypolyquadraticbeziertoexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. @@ -530,23 +530,23 @@ to treat the join between this segment and the previous segment as a corner when stroked with a ; otherwise, . Draws a quadratic Bezier curve. - method as its start point. - - A cannot be serialized if it contains a or any non-stroked or unfilled segments. - - - -## Examples - The following example shows how to draw a quadratic Bezier curve using the method. - + method as its start point. + + A cannot be serialized if it contains a or any non-stroked or unfilled segments. + + + +## Examples + The following example shows how to draw a quadratic Bezier curve using the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PolyBezierSegment/Overview/StreamGeometryQuadraticBezierToExample.cs" id="Snippetstreamgeometryquadraticbeziertoexamplewholepage"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometryquadraticbeziertoexample.vb" id="Snippetstreamgeometryquadraticbeziertoexamplewholepage"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/PolyBezierSegment/Overview/streamgeometryquadraticbeziertoexample.vb" id="Snippetstreamgeometryquadraticbeziertoexamplewholepage"::: + ]]> An attempt was made to add a segment without starting a figure by calling the method. diff --git a/xml/System.Windows.Media/TextEffect.xml b/xml/System.Windows.Media/TextEffect.xml index bca9f21640d..b0f598bccc6 100644 --- a/xml/System.Windows.Media/TextEffect.xml +++ b/xml/System.Windows.Media/TextEffect.xml @@ -39,7 +39,7 @@ ## Examples - The following example shows an individual character being rotated. Each character is rotated independently at 1-second intervals. The example a defines a that contains a that applies to each character in the property. The example defines the animations for the and properties of the object. A third animation of type changes the property from 0 to 12 during the animation sequence, corresponding to the 13-character text string. + The following example shows an individual character being rotated. Each character is rotated independently at 1-second intervals. The example a defines a that contains a that applies to each character in the property. The example defines the animations for the and properties of the object. A third animation of type changes the property from 0 to 12 during the animation sequence, corresponding to the 13-character text string. ![Screenshot of text effect rotating text](~/add/media/texteffect01.jpg "Screenshot of text effect rotating text") @@ -140,7 +140,7 @@ constructor. Notice that in this case, the `transform` and `clip` parameters are set to `null`, since those parameters values are not needed. + The following code example shows how to call the constructor. Notice that in this case, the `transform` and `clip` parameters are set to `null`, since those parameters values are not needed. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/TextEffect/.ctor/TextEffect.xaml.cs" id="Snippettexteffectsnippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/TextEffect/.ctor/texteffect.xaml.vb" id="Snippettexteffectsnippet3"::: @@ -253,7 +253,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -292,7 +292,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -437,7 +437,7 @@ value to a number that is greater than the maximum position in the affected text is valid. + Setting the value to a number that is greater than the maximum position in the affected text is valid. ## Dependency Property Information @@ -450,7 +450,7 @@ ## Examples - The following code example shows how you can set value to the maximum value to ensure that all characters in the text are affected. + The following code example shows how you can set value to the maximum value to ensure that all characters in the text are affected. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/TextEffect/.ctor/TextEffect.xaml.cs" id="Snippettexteffectsnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/TextEffect/.ctor/texteffect.xaml.vb" id="Snippettexteffectsnippet2"::: diff --git a/xml/System.Windows.Media/TextEffectCollection.xml b/xml/System.Windows.Media/TextEffectCollection.xml index 943cba65736..c6b073b06c8 100644 --- a/xml/System.Windows.Media/TextEffectCollection.xml +++ b/xml/System.Windows.Media/TextEffectCollection.xml @@ -184,11 +184,11 @@ The to add to the collection. Adds a to the end of the collection. - objects derive from , they are copied when they are used. Therefore, later, you might not be able to retrieve or remove the you added to the collection using the original object. The in the collection is a copy of the original and is considered a different than the one you added. - + objects derive from , they are copied when they are used. Therefore, later, you might not be able to retrieve or remove the you added to the collection using the original object. The in the collection is a copy of the original and is considered a different than the one you added. + ]]> @@ -254,13 +254,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -325,13 +325,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -630,21 +630,21 @@ Returns an enumerator that can iterate through the collection. An that can iterate through the collection. - also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . - - returns the same object until either or is called. sets to the next item. - - After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . - - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. - - The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - + also brings the enumerator back to this position. At this position, calling throws an exception. Therefore, you must call to advance the enumerator to the first item of the collection before reading the value of . + + returns the same object until either or is called. sets to the next item. + + After the end of the collection is passed, the enumerator is positioned after the last item in the collection, and calling returns `false`. If the last call to returned `false`, calling throws an exception. To set to the first item of the collection again, you can call followed by . + + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting items, the enumerator is irrecoverably invalidated and the next call to or throws an . If the collection is modified between and , will return the item that it is set to, even if the enumerator is already invalidated. + + The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + ]]> @@ -683,15 +683,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. - . That is, this method is an O(*n*) operation, where *n* is . - - This method determines equality by calling . - + . That is, this method is an O(*n*) operation, where *n* is . + + This method determines equality by calling . + ]]> @@ -767,11 +767,11 @@ Gets or sets the item that is stored at the zero-based index of the collection. The element at the specified index. - @@ -811,11 +811,11 @@ if was removed fro the collection; otherwise, . - @@ -854,11 +854,11 @@ The zero-based index of the to remove. Removes the at the specified index in the collection. - @@ -894,11 +894,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -934,11 +934,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -979,11 +979,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1020,11 +1020,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1059,11 +1059,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1099,11 +1099,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1143,11 +1143,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1188,11 +1188,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1232,11 +1232,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1277,11 +1277,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1318,11 +1318,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1358,11 +1358,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1407,11 +1407,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1450,11 +1450,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/TileBrush.xml b/xml/System.Windows.Media/TileBrush.xml index c5710ba1486..bfd158eae25 100644 --- a/xml/System.Windows.Media/TileBrush.xml +++ b/xml/System.Windows.Media/TileBrush.xml @@ -58,9 +58,9 @@ Components of a TileBrush with a TileMode of Tile You can specify the position and dimensions of content by using the property. - **Tiles**: A produces one or more tiles. By default, the content of the brush is stretched to fill a single tile and that tile is stretched to fill the output area. The property is used to specify the size and position of the base tile for the . The property determines whether the size and position of the are relative to the output area (the default behavior) or whether they are absolute values. + **Tiles**: A produces one or more tiles. By default, the content of the brush is stretched to fill a single tile and that tile is stretched to fill the output area. The property is used to specify the size and position of the base tile for the . The property determines whether the size and position of the are relative to the output area (the default behavior) or whether they are absolute values. - **Output Area**: The output area is the area that the brush paints, such as the of an or the of a . + **Output Area**: The output area is the area that the brush paints, such as the of an or the of a . For more information about the class, see [Painting with Images, Drawings, and Visuals](/dotnet/framework/wpf/graphics-multimedia/painting-with-images-drawings-and-visuals) . @@ -141,11 +141,11 @@ Components of a TileBrush with a TileMode of Tile and properties of a are used when either of the following conditions is true: + The and properties of a are used when either of the following conditions is true: -- The property is or and the and have different aspect ratios. +- The property is or and the and have different aspect ratios. -- The property is and the and are different sizes. +- The property is and the and are different sizes. Note that you specify the dimensions of content by using the property; you specify the position and size of the base tile by using the property. @@ -221,11 +221,11 @@ Components of a TileBrush with a TileMode of Tile and properties of a are used when either of the following conditions are true: + The and properties of a are used when either of the following conditions are true: -- The property is or and the and have different aspect ratios. +- The property is or and the and have different aspect ratios. -- The property is and the and are different sizes. +- The property is and the and are different sizes. Note that you specify the dimensions of content by using the property; you specify the position and size of the base tile by using the property. @@ -306,7 +306,7 @@ Components of a TileBrush with a TileMode of Tile When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -345,7 +345,7 @@ Components of a TileBrush with a TileMode of Tile ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -423,7 +423,7 @@ Components of a TileBrush with a TileMode of Tile - : The content is scaled to fit the tile. Because the content's height and width are scaled independently, the original aspect ratio of the content might not be preserved. That is, the content might be distorted in order to completely fill the output tile. - The following image illustrates the different settings. + The following image illustrates the different settings. ![Different TileBrush Stretch settings](~/add/media/img-mmgraphics-stretchenum.jpg "Different TileBrush Stretch settings") Different stretch settings @@ -431,9 +431,9 @@ Different stretch settings Note that you specify the dimensions of content by using the property; you specify the position and size of the base tile by using the property. ## Viewbox Clipping - contents are never clipped to the . However, contents *are* clipped to the edges of the , which sets the dimensions for the base tile. + contents are never clipped to the . However, contents *are* clipped to the edges of the , which sets the dimensions for the base tile. - The following illustration shows the effect of different settings on a that has a that is smaller than its . The parts of the image that are outside the are tinted gray. + The following illustration shows the effect of different settings on a that has a that is smaller than its . The parts of the image that are outside the are tinted gray. ![TileBrush with different Stretch settings](~/add/media/graphicsmm-viewbox-clipping.png "TileBrush with different Stretch settings") TileBrush with different Stretch settings @@ -515,7 +515,7 @@ TileBrush with different Stretch settings ![Different TileBrush TileMode settings](~/add/media/img-mmgraphics-tilemodes.gif "Different TileBrush TileMode settings") Available tile modes for the TileMode enumeration - For the property to have an effect, you must set the for the brush to a size that is smaller than the area that you are painting (the output area). If the size is equal to or exceeds the output area, the brush produces a single tile that expands to fill the output area, and no tile pattern occurs. + For the property to have an effect, you must set the for the brush to a size that is smaller than the area that you are painting (the output area). If the size is equal to or exceeds the output area, the brush produces a single tile that expands to fill the output area, and no tile pattern occurs. ## Dependency Property Information @@ -594,12 +594,12 @@ TileBrush components ![Components of a tiled TileBrush](~/add/media/graphicsmm-tiledprojection.png "Components of a tiled TileBrush") - The property determines whether the value is interpreted as a relative or absolute value. By default, the property is set to . + The property determines whether the value is interpreted as a relative or absolute value. By default, the property is set to . ## Viewbox Clipping - contents are never clipped to the . However, contents *are* clipped to the edges of the , which sets the values for the base tile. + contents are never clipped to the . However, contents *are* clipped to the edges of the , which sets the values for the base tile. - The following illustration shows the effect of different settings on a that has a that is smaller than its . The parts of the image that are outside the are tinted gray. + The following illustration shows the effect of different settings on a that has a that is smaller than its . The parts of the image that are outside the are tinted gray. ![TileBrush with different Stretch settings](~/add/media/graphicsmm-viewbox-clipping.png "TileBrush with different Stretch settings") TileBrush with different Stretch settings @@ -615,39 +615,39 @@ TileBrush with different Stretch settings ## Examples - You can specify the size and position of content by using the property. The property determines whether the value is relative to the bounds of the content or whether it is an absolute value. + You can specify the size and position of content by using the property. The property determines whether the value is relative to the bounds of the content or whether it is an absolute value. The first illustration shows a 100 by 100 pixel image and then uses this image to show the effects of different property settings. ![An image](~/add/media/graphicsmm-viewbox-sampleimage.jpg "An image") Beginning sample image (100 by 100 device independent pixels) - The following illustration shows the output of a that uses a of 0.0,0.0, 0.25,0.5. Other relevant property values include the following: + The following illustration shows the output of a that uses a of 0.0,0.0, 0.25,0.5. Other relevant property values include the following: -- : (default) +- : (default) -- : 0,0,1,1 +- : 0,0,1,1 -- : +- : -- , : +- , : - This illustration shows several different property settings. The property determines how a stretches its to fill its . + This illustration shows several different property settings. The property determines how a stretches its to fill its . ![TileBrush with a Viewbox of 0,0 0.25,0.5](~/add/media/graphicsmm-0-0-025-05-viewbox.png "TileBrush with a Viewbox of 0,0 0.25,0.5") TileBrush with a relative Viewbox of 0.0,0.0, 0.25,0.5 - The next illustration shows a similar but with a relative of 0.5,0.25, 0.25,0.5. + The next illustration shows a similar but with a relative of 0.5,0.25, 0.25,0.5. ![TileBrush with a Viewbox of 0.5,0.25 0.25,0.5](~/add/media/graphicsmm-05-0-025-05-viewbox.png "TileBrush with a Viewbox of 0.5,0.25 0.25,0.5") Similar TileBrush but with a different Viewbox setting - The next illustration shows the same but with a relative value of 0.0,0.0, 0.5,0.5 and a of . + The next illustration shows the same but with a relative value of 0.0,0.0, 0.5,0.5 and a of . ![TiledTileBrush with a Viewbox of 0.5,0.25 0.25,0.5](~/add/media/graphicsmm-05-0-025-05-viewbox-tiled.png "TiledTileBrush with a Viewbox of 0.5,0.25 0.25,0.5") Similar TileBrush but with tiling and a different Viewport setting - The following example shows how to create a tiled that has a of 0.5,0.25, 0.25,0.5. + The following example shows how to create a tiled that has a of 0.5,0.25, 0.25,0.5. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/BrushOverviewExamples_snip/XAML/ViewboxExample.xaml" id="Snippetgraphicsmmtilebrushviewboxwithstretchtiling"::: @@ -719,11 +719,11 @@ Similar TileBrush but with tiling and a different Viewport setting indicates that the are relative to the bounding box of the content. Note that a value of specifies device independent pixels instead of device pixels, which are device dependent. Therefore, when a value of applies, each pixel represents 1/96th of an inch. + A value of indicates that the are relative to the bounding box of the content. Note that a value of specifies device independent pixels instead of device pixels, which are device dependent. Therefore, when a value of applies, each pixel represents 1/96th of an inch. - You must remember this pixel distinction when you specify the of an that has a as its source. For example, when you use the standard pixel as a measure, a 300 by 300 pixel image is only one inch in width if the image resolution is 300 dots per inch. However, when you want to set an absolute value, you must set the to (0, 0, 96, 96) in order to include the whole image. + You must remember this pixel distinction when you specify the of an that has a as its source. For example, when you use the standard pixel as a measure, a 300 by 300 pixel image is only one inch in width if the image resolution is 300 dots per inch. However, when you want to set an absolute value, you must set the to (0, 0, 96, 96) in order to include the whole image. - You can specify the size and position of content by using the property. The property determines whether the value is relative to the bounds of the content or whether it is an absolute value. + You can specify the size and position of content by using the property. The property determines whether the value is relative to the bounds of the content or whether it is an absolute value. ## Dependency Property Information @@ -807,7 +807,7 @@ Components of a TileBrush with a TileMode of Tile The property determines the size and position of the tiles in a . By default, a has a single tile that fills the whole output area. The property controls how the content fits into that tile. You can override this default behavior and specify the tile size by using the property. - Use the property to specify whether the uses absolute or relative coordinates. If the coordinates are relative, they are relative to the size of the output area. The point (0,0) represents the upper-left corner of the output area, and (1,1) represents the lower-right corner of the output area. To specify that the property uses absolute coordinates, set the property to . + Use the property to specify whether the uses absolute or relative coordinates. If the coordinates are relative, they are relative to the size of the output area. The point (0,0) represents the upper-left corner of the output area, and (1,1) represents the lower-right corner of the output area. To specify that the property uses absolute coordinates, set the property to . The following illustration shows the difference in output when you set the property of a to either relative or absolute. @@ -890,7 +890,7 @@ Relative and absolute ViewportUnits ## Remarks The property determines the size and position of the tiles in a . By default, a has a single tile that fills the whole output area. The property controls how the content fits into that tile. You can override this default behavior and specify the tile size by using the property. - Use the property to specify whether the uses absolute or relative coordinates. If the coordinates are relative, they are relative to the size of the output area. The point (0,0) represents the upper-left corner of the output area, and (1,1) represents the lower-right corner of the output area. To specify that the property uses absolute coordinates, set the property to . + Use the property to specify whether the uses absolute or relative coordinates. If the coordinates are relative, they are relative to the size of the output area. The point (0,0) represents the upper-left corner of the output area, and (1,1) represents the lower-right corner of the output area. To specify that the property uses absolute coordinates, set the property to . The following illustration shows the difference in output when you set the property of a to either relative or absolute. diff --git a/xml/System.Windows.Media/Transform.xml b/xml/System.Windows.Media/Transform.xml index 097f8defb31..0a8506a7da4 100644 --- a/xml/System.Windows.Media/Transform.xml +++ b/xml/System.Windows.Media/Transform.xml @@ -52,15 +52,15 @@ | Column 1 | Column 2 | Column 3 | |----------|----------|----------| -|||0| -|||0| -|||1| +|||0| +|||0| +|||1| - The members in the last row, and , represent translation values. + The members in the last row, and , represent translation values. Methods and properties usually specify the transformation matrix as a vector that has only six members; they are as follows: - (, , , , , ) + (, , , , , ) ]]> @@ -101,7 +101,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -140,7 +140,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -337,7 +337,7 @@ method, this method does not throw an exception if the transformation is unsuccessful. + Unlike the method, this method does not throw an exception if the transformation is unsuccessful. ]]> diff --git a/xml/System.Windows.Media/TransformCollection.xml b/xml/System.Windows.Media/TransformCollection.xml index 8f03e5b3a46..d8dcb942a6e 100644 --- a/xml/System.Windows.Media/TransformCollection.xml +++ b/xml/System.Windows.Media/TransformCollection.xml @@ -51,29 +51,29 @@ Represents a collection of objects that can be individually accessed by index. - , , and documentation. - - **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - - -## XAML Implicit Collection Usage - -``` - - - oneOrMoreTransformObjectElements - - -``` - - -## XAML Values - *oneOrMoreTransformKeyFrameObjectElements* - One or more objects, declared using object element syntax. - + , , and documentation. + + **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + + +## XAML Implicit Collection Usage + +``` + + + oneOrMoreTransformObjectElements + + +``` + + +## XAML Values + *oneOrMoreTransformKeyFrameObjectElements* + One or more objects, declared using object element syntax. + ]]> @@ -208,19 +208,19 @@ The to add to the end of the . Adds a to the end of the . - , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + ]]> is . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -256,11 +256,11 @@ Removes all items from the . - . - + . + ]]> The is read-only. @@ -295,13 +295,13 @@ Creates a modifiable clone of this , making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -366,13 +366,13 @@ Creates a modifiable clone of this object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. A modifiable clone of the current object. The cloned object's property will be even if the source's property was . - objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - - For more information, see . - + objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. + + For more information, see . + ]]> @@ -487,10 +487,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of items in the source is greater than the available space from to the end of the destination . @@ -758,21 +758,21 @@ The to insert into the . Inserts a into the at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -811,21 +811,21 @@ Gets or sets the at the specified index. The at the specified index. - , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. - + , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + ]]> is . is not a valid index in the . - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -865,10 +865,10 @@ if was removed from the ; otherwise, . To be added. - The is read-only. - + The is read-only. + -or- - + The has a fixed size. @@ -941,11 +941,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -982,11 +982,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1027,11 +1027,11 @@ The first position in the specified to receive the copied contents. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1068,11 +1068,11 @@ if access to the is synchronized (thread safe); otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1107,11 +1107,11 @@ For a description of this member, see . An object that can be used to synchronize access to the . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1147,11 +1147,11 @@ For a description of this member, see . An object that can be used to iterate through the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1191,11 +1191,11 @@ For a description of this member, see . The position into which the new element was inserted. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1236,11 +1236,11 @@ if the is found in the ; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1280,11 +1280,11 @@ For a description of this member, see . The index of if found in the list; otherwise, -1. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1325,11 +1325,11 @@ The to insert into the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1366,11 +1366,11 @@ if the has a fixed size; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1407,11 +1407,11 @@ if the is read-only; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1457,11 +1457,11 @@ For a description of this member, see . The element at the specified index. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1500,11 +1500,11 @@ The to remove from the . For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows.Media/TransformGroup.xml b/xml/System.Windows.Media/TransformGroup.xml index 0ad526a2b62..3569846ca01 100644 --- a/xml/System.Windows.Media/TransformGroup.xml +++ b/xml/System.Windows.Media/TransformGroup.xml @@ -177,7 +177,7 @@ When this method copies dependency properties, it copies resource references and data bindings although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -216,7 +216,7 @@ ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/TranslateTransform.xml b/xml/System.Windows.Media/TranslateTransform.xml index ee12d30b7ce..26fecb1e953 100644 --- a/xml/System.Windows.Media/TranslateTransform.xml +++ b/xml/System.Windows.Media/TranslateTransform.xml @@ -140,7 +140,7 @@ Typical 3x3 matrix for 2-D translations When this method copies dependency properties, it copies resource references and data bindings, although they might no longer resolve. It does not copy animations or their current values. - For more information, see . + For more information, see . ]]> @@ -179,7 +179,7 @@ Typical 3x3 matrix for 2-D translations ## Remarks Use this method to produce modifiable copies of read-only objects. For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/VectorCollection.xml b/xml/System.Windows.Media/VectorCollection.xml index fe9a43ce06b..b3ceb103a16 100644 --- a/xml/System.Windows.Media/VectorCollection.xml +++ b/xml/System.Windows.Media/VectorCollection.xml @@ -67,7 +67,7 @@ , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. + Members of this class behave exactly as described by the , , and documentation, except that this implementation throws an if you attempt to insert `null` into the collection. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as [resources](/dotnet/desktop-wpf/fundamentals/xaml-resources-define), shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -238,7 +238,7 @@ , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to add a **null** (**Nothing**) reference. ]]> @@ -327,7 +327,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -398,7 +398,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -755,7 +755,7 @@ , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. ]]> @@ -808,7 +808,7 @@ , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. + Unlike typical implementations of , this implementation throws an if you attempt to insert a **null** (**Nothing**) reference. ]]> @@ -971,7 +971,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1012,7 +1012,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows.Media/VectorCollectionConverter.xml b/xml/System.Windows.Media/VectorCollectionConverter.xml index 5a6590dabfe..1f15bfcc5e2 100644 --- a/xml/System.Windows.Media/VectorCollectionConverter.xml +++ b/xml/System.Windows.Media/VectorCollectionConverter.xml @@ -164,11 +164,11 @@ Attempts to convert the specified object to a . The that is created from converting . - method. - + method. + ]]> @@ -210,11 +210,11 @@ Attempts to convert a to a specified type. The object that is created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows.Media/VideoDrawing.xml b/xml/System.Windows.Media/VideoDrawing.xml index 295795b17af..4a32c28928d 100644 --- a/xml/System.Windows.Media/VideoDrawing.xml +++ b/xml/System.Windows.Media/VideoDrawing.xml @@ -28,7 +28,7 @@ class and in particular the and methods. To play media in XAML only, use a . + Although you can declare an instance of this class in XAML, you cannot load and play its media without using code, because of the dependency on the class and in particular the and methods. To play media in XAML only, use a . Despite its name, a can be used to play audio. @@ -101,7 +101,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -140,7 +140,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> diff --git a/xml/System.Windows.Media/Visual.xml b/xml/System.Windows.Media/Visual.xml index f2331b55914..af6faf2c51b 100644 --- a/xml/System.Windows.Media/Visual.xml +++ b/xml/System.Windows.Media/Visual.xml @@ -139,12 +139,12 @@ Visual class hierarchy method sets up the parent-child relationship between two visual objects. This method must be used when you need greater low-level control over the underlying storage implementation of visual child objects. can be used as a default implementation for storing child objects. + The method sets up the parent-child relationship between two visual objects. This method must be used when you need greater low-level control over the underlying storage implementation of visual child objects. can be used as a default implementation for storing child objects. ## Examples - The following example shows how to define custom storage requirements for a visual child. The example uses the and methods to sets up the parent-child relationship between the parent visual and `child`. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. + The following example shows how to define custom storage requirements for a visual child. The example uses the and methods to sets up the parent-child relationship between the parent visual and `child`. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. > [!NOTE] > Although it is possible to use to create parent-child relationships between visual objects, it is more efficient to provide your own custom storage implementation when only one child is linked to a parent. @@ -236,7 +236,7 @@ Visual class hierarchy ## Examples - The following example defines an overridden implementation of . + The following example defines an overridden implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/Window1.xaml.cs" id="Snippet102b"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet102b"::: @@ -291,12 +291,12 @@ Visual class hierarchy method. This means that when you invoke the method, your overridden implementation of is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object. + You can override default hit testing support for a visual object by overriding the method. This means that when you invoke the method, your overridden implementation of is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object. ## Examples - The following example shows how to override the method. One reason you might want to override this method is to provide additional functionality during the hit testing process. + The following example shows how to override the method. One reason you might want to override this method is to provide additional functionality during the hit testing process. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/GeometryHitTest.cs" id="Snippethittestingoverviewsnippet13"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/geometryhittest.vb" id="Snippethittestingoverviewsnippet13"::: @@ -339,12 +339,12 @@ Visual class hierarchy method. This means that when you invoke the method, your overridden implementation of is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object. + You can override the default hit testing support on visual objects by overriding the method. This means that when you invoke the method, your overridden implementation of is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object. ## Examples - The following example shows how to override the method. One reason you might want to override this method is to provide additional functionality during the hit testing process. + The following example shows how to override the method. One reason you might want to override this method is to provide additional functionality during the hit testing process. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet107"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet107"::: @@ -528,7 +528,7 @@ Visual class hierarchy ## Examples - The following example defines an overridden implementation of . + The following example defines an overridden implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet10"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet10"::: @@ -572,7 +572,7 @@ Visual class hierarchy method to convert a that represents the current coordinate system of the into a in screen coordinates. + Use the method to convert a that represents the current coordinate system of the into a in screen coordinates. ]]> @@ -612,7 +612,7 @@ Visual class hierarchy method to convert a in screen coordinates into a that represents the current coordinate system of the . + Use the method to convert a in screen coordinates into a that represents the current coordinate system of the . ]]> @@ -651,12 +651,12 @@ Visual class hierarchy method removes the parent-child relationship between two visuals. This method, along with the method, must be used when you need greater low-level control over the underlying storage implementation of visual child objects. can be used as a default implementation for storing child objects. + The method removes the parent-child relationship between two visuals. This method, along with the method, must be used when you need greater low-level control over the underlying storage implementation of visual child objects. can be used as a default implementation for storing child objects. ## Examples - The following example shows how to define custom storage requirements for a visual child. The example uses the and methods to sets up the parent-child relationship between the parent visual and `child`. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. + The following example shows how to define custom storage requirements for a visual child. The example uses the and methods to sets up the parent-child relationship between the parent visual and `child`. In order for the visual tree to be enumerated correctly, the example provides overridden implementations of the method and property. > [!NOTE] > Although it is possible to use to create parent-child relationships between visual objects, it is more efficient to provide your own custom storage implementation when only one child is linked to a parent. @@ -745,7 +745,7 @@ Visual class hierarchy method to retrieve the offset of a visual object relative to its parent. The offset values are contained within the returned value. + Alternatively, you can use the method to retrieve the offset of a visual object relative to its parent. The offset values are contained within the returned value. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet2"::: @@ -757,12 +757,12 @@ Visual class hierarchy :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window2.xaml" id="Snippetvisualsnippet7"::: - The following code example shows how to use the method to retrieve the offset of the relative to the containing . The offset values are contained in the returned . + The following code example shows how to use the method to retrieve the offset of the relative to the containing . The offset values are contained in the returned . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet5"::: - The offset takes into account the values for all objects within the containing . In this case, is 28, and is 28. + The offset takes into account the values for all objects within the containing . In this case, is 28, and is 28. ]]> @@ -811,12 +811,12 @@ Visual class hierarchy :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml" id="Snippetvisualsnippet4"::: - The following code example shows how to use the method to retrieve the offset of the relative to its child . The offset values are contained within the returned value. + The following code example shows how to use the method to retrieve the offset of the relative to its child . The offset values are contained within the returned value. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet9"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet9"::: - The offset takes into account the values for all objects. In this case, is -4, and is -4. The offset values are negative values because the parent object is negatively offset relative to its child object. + The offset takes into account the values for all objects. In this case, is -4, and is -4. The offset values are negative values because the parent object is negatively offset relative to its child object. ]]> @@ -860,7 +860,7 @@ Visual class hierarchy and methods can also be used to return a transform for a visual object. + The and methods can also be used to return a transform for a visual object. @@ -869,12 +869,12 @@ Visual class hierarchy :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml" id="Snippetvisualsnippet4"::: - The following code example shows how to use the method to retrieve the offset of the relative to its child . The offset values are contained within the returned value. + The following code example shows how to use the method to retrieve the offset of the relative to its child . The offset values are contained within the returned value. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet8"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet8"::: - The offset takes into account the values for all objects. In this case, is -4, and is -4. The offset values are negative values because the parent object is negatively offset relative to its child object. + The offset takes into account the values for all objects. In this case, is -4, and is -4. The offset values are negative values because the parent object is negatively offset relative to its child object. ]]> @@ -1066,7 +1066,7 @@ Visual class hierarchy ## Examples - The following example defines an overridden implementation of . + The following example defines an overridden implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingContext/Overview/Window1.xaml.cs" id="Snippet102a"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingContext/Overview/window1.xaml.vb" id="Snippet102a"::: @@ -1383,7 +1383,7 @@ Visual class hierarchy - Changing the subtree or triggering parts of the scrollable area to redraw via animation behave as expected, but lose the benefit of accelerated scrolling for the redrawn area. Any animation that invalidates the scrolled area during the same frame in which scrolling occurs eliminates the benefit of this optimization. -- The rectangle snaps inward to pixels. Therefore, the snapped size of the scrolling rectangle is always less than or equal to the size you have set. +- The rectangle snaps inward to pixels. Therefore, the snapped size of the scrolling rectangle is always less than or equal to the size you have set. - Offsets snap downward. This means that the difference of the previous snapped offset and current snapped offset is always an integer number of pixels. diff --git a/xml/System.Windows.Media/VisualBrush.xml b/xml/System.Windows.Media/VisualBrush.xml index 6d1f23d73bf..1e590a1b5dd 100644 --- a/xml/System.Windows.Media/VisualBrush.xml +++ b/xml/System.Windows.Media/VisualBrush.xml @@ -28,15 +28,15 @@ content of a . + There are two ways to specify the content of a . - Create a new and use it to set the property of the . - Use an existing , which creates a duplicate image of the target . You can then use the to create interesting effects, such as reflection and magnification. - When you define a new for a and that is a (such as a panel or control), the layout system runs on the and its child elements when the property is set to `true`. However, the root is essentially isolated from the rest of the system; styles, storyboards, and external layout can't permeate this boundary. Therefore, you should explicitly specify the size of the root , because its only parent is the and therefore it cannot automatically size itself to the area being painted. For more information about layout in Windows Presentation Foundation (WPF), see the [Layout](/dotnet/framework/wpf/advanced/layout). + When you define a new for a and that is a (such as a panel or control), the layout system runs on the and its child elements when the property is set to `true`. However, the root is essentially isolated from the rest of the system; styles, storyboards, and external layout can't permeate this boundary. Therefore, you should explicitly specify the size of the root , because its only parent is the and therefore it cannot automatically size itself to the area being painted. For more information about layout in Windows Presentation Foundation (WPF), see the [Layout](/dotnet/framework/wpf/advanced/layout). - Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can workaround this limitation by forcing an update of the scene on the object above the effect. You can call or include an animation to force a scene update. + Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can workaround this limitation by forcing an update of the scene on the object above the effect. You can call or include an animation to force a scene update. **Freezable Features:** Because it inherits from the class, the class provides several special features: objects can be declared as and shared among multiple objects. For more information about the different features provided by objects, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). @@ -141,7 +141,7 @@ is a non-parented . + Setting this property to `true` has an effect only when this brush's is a non-parented . ## Dependency Property Information @@ -239,7 +239,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. @@ -280,7 +280,7 @@ ## Remarks This method is used to produce modifiable copies of frozen objects (or any object). For convenience, this method shadows the inherited version with a strongly typed implementation. - For more information, see . + For more information, see . ]]> @@ -410,7 +410,7 @@ content of a . + There are two ways to specify the content of a . - Create a new and use it to set the property of the . @@ -418,9 +418,9 @@ is quite high in the overall WPF class hierarchy, so a very large number of objects could possibly serve as the visual that you use for a ; the entire list cannot be shown here. See ; refer to the "Inheritance Hierarchy" section, which will show the immediately derived classes. You can then click on the immediately derived classes and traverse the hierarchies to get a sense of the full range of possibilities. At a top level, the two most common categories of objects you might use for a are or . encompasses basically any UI element that can otherwise participate in the UI for a WPF application. contains a that includes one or more -derived objects. - When you define a new for a and that is a (such as a panel or control), the layout system runs on the and its child elements when the property is set to `true`. However, the root is essentially isolated from the rest of the system; styles, storyboards, and external layout dictated by the parent where the brush is applied cannot permeate this boundary. Therefore, you should explicitly specify the size of the root , because its only parent is the and therefore it cannot automatically size itself to the area being painted. For more information about layout in Windows Presentation Foundation (WPF), see the [Layout](/dotnet/framework/wpf/advanced/layout). + When you define a new for a and that is a (such as a panel or control), the layout system runs on the and its child elements when the property is set to `true`. However, the root is essentially isolated from the rest of the system; styles, storyboards, and external layout dictated by the parent where the brush is applied cannot permeate this boundary. Therefore, you should explicitly specify the size of the root , because its only parent is the and therefore it cannot automatically size itself to the area being painted. For more information about layout in Windows Presentation Foundation (WPF), see the [Layout](/dotnet/framework/wpf/advanced/layout). - Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can work around this limitation by forcing an update of the scene on the object above the effect. You can call or include an animation to force a scene update. + Updates to the visual tree of a will not propagate if a is in the brush's parent chain. You can work around this limitation by forcing an update of the scene on the object above the effect. You can call or include an animation to force a scene update. > [!NOTE] > A cannot be made read-only (frozen) when its property is set to any value other than `null`. diff --git a/xml/System.Windows.Media/VisualCollection.xml b/xml/System.Windows.Media/VisualCollection.xml index 4cc7abad647..a22d8665001 100644 --- a/xml/System.Windows.Media/VisualCollection.xml +++ b/xml/System.Windows.Media/VisualCollection.xml @@ -116,9 +116,9 @@ ## Remarks Adding a whose value is `null` is permitted and does not raise an exception. - The method also sets up the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. + The method also sets up the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. - If you need greater low-level control over the underlying storage implementation of visual child objects of a custom class, consider using the and methods. When you use these methods, you must define your own storage implementation, and do not use . + If you need greater low-level control over the underlying storage implementation of visual child objects of a custom class, consider using the and methods. When you use these methods, you must define your own storage implementation, and do not use . @@ -166,7 +166,7 @@ is the number of elements that the is capable of storing. is the number of visuals that are actually in the . is always greater than or equal to . If exceeds while adding elements, the capacity of the is increased. By default is zero. + The value of is the number of elements that the is capable of storing. is the number of visuals that are actually in the . is always greater than or equal to . If exceeds while adding elements, the capacity of the is increased. By default is zero. ]]> @@ -204,7 +204,7 @@ is reset to zero. The value of the remains unchanged. To reset the capacity of the , set the property to the desired size. + The is reset to zero. The value of the remains unchanged. To reset the capacity of the , set the property to the desired size. ]]> @@ -364,9 +364,9 @@ is the number of elements that are actually in the . is the number of elements that the is capable of storing. + is the number of elements that are actually in the . is the number of elements that the is capable of storing. - is always less than or equal to . If exceeds while adding elements, the capacity of the list is doubled by automatically reallocating the internal array before copying the old elements and adding the new elements. + is always less than or equal to . If exceeds while adding elements, the capacity of the list is doubled by automatically reallocating the internal array before copying the old elements and adding the new elements. ]]> @@ -478,11 +478,11 @@ already equals , the capacity of the is increased before the new is inserted. If `index` is equal to , `visual` is added to the end of . Any existing visual objects that are equal to or greater than `index` are shifted to accommodate the new , and their index values are updated. + If already equals , the capacity of the is increased before the new is inserted. If `index` is equal to , `visual` is added to the end of . Any existing visual objects that are equal to or greater than `index` are shifted to accommodate the new , and their index values are updated. - The method also sets up the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. + The method also sets up the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. - If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . + If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . ]]> @@ -643,9 +643,9 @@ ## Remarks The visual objects that follow the removed object are shifted to occupy the vacated position, and their index values are updated. If `visual` is `null`, the first `null` entry is removed. Note that removing a `null` entry is linear in the size of the collection. - The method also removes the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. + The method also removes the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. - If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . + If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . ]]> @@ -686,9 +686,9 @@ ## Remarks The visual objects that follow the removed object are shifted to occupy the vacated position, and their index values are updated. - The method also removes the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. + The method also removes the parent-child relationship between the parent visual, which is the owner of the , and the child `visual`. - If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . + If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . ]]> @@ -733,9 +733,9 @@ ## Remarks The visual objects that follow the removed objects are shifted to occupy the vacated positions, and their index values are updated. - The method also removes the parent-child relationships between the parent visual, which is the owner of the , and the range of child visuals. + The method also removes the parent-child relationships between the parent visual, which is the owner of the , and the range of child visuals. - If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . + If you need greater low-level control over the underlying storage implementation of visual child objects, consider using the and methods. When you use these methods, you define your own storage implementation, and do not use . ]]> diff --git a/xml/System.Windows.Media/VisualTreeHelper.xml b/xml/System.Windows.Media/VisualTreeHelper.xml index d3f7031e7fd..78fe0a4afbe 100644 --- a/xml/System.Windows.Media/VisualTreeHelper.xml +++ b/xml/System.Windows.Media/VisualTreeHelper.xml @@ -179,7 +179,7 @@ method to determine the total number of child elements of a parent visual. + Call the method to determine the total number of child elements of a parent visual. The value of `reference` can represent either a or object, which is why the common base type is used here as a parameter type. @@ -229,7 +229,7 @@ method to retrieve a specified child of a parent visual. + Use the method to retrieve a specified child of a parent visual. The value of `reference` can represent either a or object, which is why the common base type is used here as a parameter type. @@ -323,7 +323,7 @@ method to return the union of all the content bounding boxes for all the descendants of a 3D visual object, which includes the itself. + Use the method to return the union of all the content bounding boxes for all the descendants of a 3D visual object, which includes the itself. ]]> @@ -364,7 +364,7 @@ method to return the union of all the content bounding boxes for all the descendants of a visual object, which includes the itself. + Call the method to return the union of all the content bounding boxes for all the descendants of a visual object, which includes the itself. @@ -422,7 +422,7 @@ method to return the cached bounding box rectangle for a 3D visual object. + Call the method to return the cached bounding box rectangle for a 3D visual object. ]]> @@ -462,7 +462,7 @@ method to return the cached bounding box rectangle for a . + Call the method to return the cached bounding box rectangle for a . @@ -542,7 +542,7 @@ from a visual object by using the method. A hit test is then performed on the geometry of each drawing in the to determine which geometry was hit. + The following example shows how to retrieve the from a visual object by using the method. A hit test is then performed on the geometry of each drawing in the to determine which geometry was hit. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/VisualTreeHelper/Overview/Window1.xaml.cs" id="Snippetvisualsoverviewsnippet4"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/VisualTreeHelper/Overview/window1.xaml.vb" id="Snippetvisualsoverviewsnippet4"::: @@ -666,21 +666,21 @@ . If you want to return an offset value that is not relative to the parent of a , use the method. + The returned offset value is relative to the parent of the . If you want to return an offset value that is not relative to the parent of a , use the method. ## Examples - The following markup example shows a that is defined with value of 4. + The following markup example shows a that is defined with value of 4. :::code language="xaml" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml" id="Snippetvisualsnippet1"::: - The following code example shows how to use the method to retrieve the offset of the . The offset values are contained within the returned value. + The following code example shows how to use the method to retrieve the offset of the . The offset values are contained within the returned value. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet2"::: - The offset takes into account the value. In this case, is 4, and is 4. + The offset takes into account the value. In this case, is 4, and is 4. ]]> @@ -844,7 +844,7 @@ method to return a transform value for the ancestor of a . This method always returns a valid transform. The following code example shows how to use method. + Alternatively, you can use the method to return a transform value for the ancestor of a . This method always returns a valid transform. The following code example shows how to use method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet3"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet3"::: @@ -852,12 +852,12 @@ ## Examples - The following code example shows how to use the method to retrieve the transform for the specified visual object. + The following code example shows how to use the method to retrieve the transform for the specified visual object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/DrawingVisual/Drawing/Window1.xaml.cs" id="Snippetvisualsnippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/DrawingVisual/Drawing/window1.xaml.vb" id="Snippetvisualsnippet6"::: - Your code should test for `null` before using the returned value. To return the offset of the returned transform, use the method. The offset value is relative to the parent of the . + Your code should test for `null` before using the returned value. To return the offset of the returned transform, use the method. The offset value is relative to the parent of the . ]]> @@ -1020,7 +1020,7 @@ ## Examples - The following example shows how to use the method to hit test the objects within a . + The following example shows how to use the method to hit test the objects within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet100"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet100"::: @@ -1125,7 +1125,7 @@ ## Examples - The following example shows how to use the method to hit test the objects within a . + The following example shows how to use the method to hit test the objects within a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet101"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Media/GeometryHitTestParameters/Overview/window1.xaml.vb" id="Snippet101"::: diff --git a/xml/System.Windows.Navigation/BaseUriHelper.xml b/xml/System.Windows.Navigation/BaseUriHelper.xml index 788e4989f00..d8cafa454bd 100644 --- a/xml/System.Windows.Navigation/BaseUriHelper.xml +++ b/xml/System.Windows.Navigation/BaseUriHelper.xml @@ -121,7 +121,7 @@ property if it is implemented or the attached property if is set on an element. will traverse the parent elements of `element` to search for the nearest ( or attached property). + Use this method to get the property if it is implemented or the attached property if is set on an element. will traverse the parent elements of `element` to search for the nearest ( or attached property). ]]> diff --git a/xml/System.Windows.Navigation/CustomContentState.xml b/xml/System.Windows.Navigation/CustomContentState.xml index 866b24f0ab3..3b6f0e540d0 100644 --- a/xml/System.Windows.Navigation/CustomContentState.xml +++ b/xml/System.Windows.Navigation/CustomContentState.xml @@ -41,13 +41,13 @@ - Calling **AddBackEntry**: - - + - - - + - - - . + - . -- Setting when one of the following events are raised: +- Setting when one of the following events are raised: - @@ -62,19 +62,19 @@ > [!NOTE] > If you call the **AddBackEntry** method, you must handle the **Navigating** event or implement . - When the navigation history entry is navigated to, WPF checks to see if a custom object is associated with it. If so, it calls to allow the custom object to apply the state it remembered from the previous navigation. + When the navigation history entry is navigated to, WPF checks to see if a custom object is associated with it. If so, it calls to allow the custom object to apply the state it remembered from the previous navigation. - A custom class can override to change the name that appears for the navigation history entry to which the object is associated. The value that returns is visible from the navigation UI of the various navigators (browser, , or ). + A custom class can override to change the name that appears for the navigation history entry to which the object is associated. The value that returns is visible from the navigation UI of the various navigators (browser, , or ). A class that derives from must be serializable, which means it must at least be augmented with , and optionally implement . > [!IMPORTANT] -> When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state if don't want the content to be retained in memory. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, consider using instead. +> When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state if don't want the content to be retained in memory. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, consider using instead. ## Examples - The following is an example of a implementation that overrides . + The following is an example of a implementation that overrides . :::code language="csharp" source="~/snippets/csharp/System.Windows.Navigation/CustomContentState/Overview/MyCustomContentState.cs" id="Snippetmycustomcontentstatecode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Navigation/CustomContentState/Overview/mycustomcontentstate.vb" id="Snippetmycustomcontentstatecode"::: @@ -148,12 +148,12 @@ ## Remarks Entries stored in back and forward navigation history are typically available from the back and forward drop down navigation buttons on the navigation UI of the host navigator, including , , or a web browser. - is the value that is displayed in a navigation history drop down list. + is the value that is displayed in a navigation history drop down list. - does not have to be overridden; if not, the following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: + does not have to be overridden; if not, the following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: -- . -- and the uniform resource identifier (URI) for the current page. +- . +- and the uniform resource identifier (URI) for the current page. - The uniform resource identifier (URI) for the current page. ]]> @@ -198,9 +198,9 @@ is called when an item in navigation history that has an associated object is navigated to. + is called when an item in navigation history that has an associated object is navigated to. - When deriving from the abstract class, must be overridden, although the override implementation need only call the base method. + When deriving from the abstract class, must be overridden, although the override implementation need only call the base method. ]]> diff --git a/xml/System.Windows.Navigation/FragmentNavigationEventArgs.xml b/xml/System.Windows.Navigation/FragmentNavigationEventArgs.xml index be919b63e80..459194db247 100644 --- a/xml/System.Windows.Navigation/FragmentNavigationEventArgs.xml +++ b/xml/System.Windows.Navigation/FragmentNavigationEventArgs.xml @@ -24,35 +24,35 @@ Provides data for the **FragmentNavigation** event. - - -- - -- - -- - - By default, a content fragment is content that is contained by a named , which is a whose attribute is set, e.g.: - -``` -... -``` - - You navigate to a XAML fragment by providing a URI with a suffix in the following format: - - \#*FragmentName* - - The following shows an example of a URI that refers to a content fragment: - - [http://www.microsoft.com/targetpage.xaml#FragmentName](http://www.www.com/homepage.xaml) - - You can handle the **FragmentNavigation** event and use to implement a custom content fragment handling implementation. - + + +- + +- + +- + + By default, a content fragment is content that is contained by a named , which is a whose attribute is set, e.g.: + +``` +... +``` + + You navigate to a XAML fragment by providing a URI with a suffix in the following format: + + \#*FragmentName* + + The following shows an example of a URI that refers to a content fragment: + + [http://www.microsoft.com/targetpage.xaml#FragmentName](http://www.www.com/homepage.xaml) + + You can handle the **FragmentNavigation** event and use to implement a custom content fragment handling implementation. + ]]> @@ -130,13 +130,13 @@ if the navigation has been handled; otherwise, . - is set to `false`, the system attempts to find an element with the name of the fragment and bring it into view. - - When you handle the **FragmentNavigation** event and use to implement a custom content fragment handling implementation, you need to set is set to `true` to override the default behavior. - + is set to `false`, the system attempts to find an element with the name of the fragment and bring it into view. + + When you handle the **FragmentNavigation** event and use to implement a custom content fragment handling implementation, you need to set is set to `true` to override the default behavior. + ]]> diff --git a/xml/System.Windows.Navigation/IProvideCustomContentState.xml b/xml/System.Windows.Navigation/IProvideCustomContentState.xml index c3cc0ab9f39..bb44e0d34bd 100644 --- a/xml/System.Windows.Navigation/IProvideCustomContentState.xml +++ b/xml/System.Windows.Navigation/IProvideCustomContentState.xml @@ -31,13 +31,13 @@ - Calling **AddBackEntry**: - - + - - - + - - - . + - . -- Setting when one of the following events are raised: +- Setting when one of the following events are raised: - @@ -51,16 +51,16 @@ 1. **AddBackEntry** is called to associate a custom state with the current content. -2. The navigation history entry is navigated back to, and the method of the custom state is called, and the state is applied to the content. +2. The navigation history entry is navigated back to, and the method of the custom state is called, and the state is applied to the content. 3. The previous content is navigated to in forward navigation history. 4. The navigation history entry is navigated back to, but the custom state has not been retained since the last time the navigation history entry it was associated with was navigated to. - This is the default behavior because the state that is initially recorded in custom state may change after it was added to navigation history. If the custom state object is navigated back to and its state is applied, before some aspect about the state changes before the entry in navigation history is navigated to, the change in state cannot be reflected in the custom state object. Furthermore, can't be explicitly called to add a new custom state object that reflects the state changes. Consequently, to ensure the current state for a particular navigation is always stored in navigation history, is called. + This is the default behavior because the state that is initially recorded in custom state may change after it was added to navigation history. If the custom state object is navigated back to and its state is applied, before some aspect about the state changes before the entry in navigation history is navigated to, the change in state cannot be reflected in the custom state object. Furthermore, can't be explicitly called to add a new custom state object that reflects the state changes. Consequently, to ensure the current state for a particular navigation is always stored in navigation history, is called. > [!IMPORTANT] -> When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, you might consider using instead. +> When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, you might consider using instead. ]]> diff --git a/xml/System.Windows.Navigation/JournalEntry.xml b/xml/System.Windows.Navigation/JournalEntry.xml index cbbae11738e..9a1555b7d48 100644 --- a/xml/System.Windows.Navigation/JournalEntry.xml +++ b/xml/System.Windows.Navigation/JournalEntry.xml @@ -42,32 +42,32 @@ An entry for the current item is added to back navigation history when a forward navigation occurs. This occurs in the following situations: -- The `Navigate` method is called (, , ). +- The `Navigate` method is called (, , ). -- The `GoForward` method is called (, , ). +- The `GoForward` method is called (, , ). - The forward button on the navigation UI that is displayed from the current navigator (XBAP, , ). Likewise, an entry for the current item is added to forward navigation history before a back navigation occurs, which happens when: -- The `GoBack` method is called (, , ). +- The `GoBack` method is called (, , ). - The back button on the navigation UI that is displayed from the current navigator (XBAP, , ). Each entry in back and forward navigation history is an instance of the class. - Each object encapsulates information about a particular navigation, including a name for the entry (), whether the entry is kept alive () and the uniform resource identifier (URI) for the content that is navigated to (). + Each object encapsulates information about a particular navigation, including a name for the entry (), whether the entry is kept alive () and the uniform resource identifier (URI) for the content that is navigated to (). - You can retrieve all the objects in back navigation history by enumerating the or properties. For forward navigation history, you can retrieve all the objects by enumerating the or properties. + You can retrieve all the objects in back navigation history by enumerating the or properties. For forward navigation history, you can retrieve all the objects by enumerating the or properties. - If you need to remove the most recent object from back navigation history, to prevent navigation to it, for example, you can call the `RemoveBackEntry` method (, , ), which removes the object and returns a reference to it. + If you need to remove the most recent object from back navigation history, to prevent navigation to it, for example, you can call the `RemoveBackEntry` method (, , ), which removes the object and returns a reference to it. - You cannot add objects to navigation history, however, because you can neither instantiate nor derive from , and because no type implements a member to do so. However, you can add custom objects to back navigation history by calling the `AddBackEntry` method (, , ); adds the object to an internally-created object, which is then added to the back navigation history. + You cannot add objects to navigation history, however, because you can neither instantiate nor derive from , and because no type implements a member to do so. However, you can add custom objects to back navigation history by calling the `AddBackEntry` method (, , ); adds the object to an internally-created object, which is then added to the back navigation history. ## Examples - The following example shows how to retrieve the most recent object from the back navigation stack to get the and property values. + The following example shows how to retrieve the most recent object from the back navigation stack to get the and property values. :::code language="csharp" source="~/snippets/csharp/System.Windows.Navigation/JournalEntry/Overview/DatePage.xaml.cs" id="Snippetgetjournalentrycodebehind"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Navigation/JournalEntry/Overview/datepage.xaml.vb" id="Snippetgetjournalentrycodebehind"::: @@ -283,7 +283,7 @@ for how this property is used by pages. + See for how this property is used by pages. ## Dependency Property Information @@ -364,9 +364,9 @@ ## Remarks Content hosted by , , or a browser displays navigation UI that allows users to navigate through back and forward navigation history. The text that is displayed for each entry in navigation history depends on which of the following pieces of data are used to automatically construct a navigation history entry name, in order of precedence: -- The attached attribute. -- . -- and the uniform resource identifier (URI) for the current page. +- The attached attribute. +- . +- and the uniform resource identifier (URI) for the current page. - The uniform resource identifier (URI) for the current page. diff --git a/xml/System.Windows.Navigation/JournalEntryUnifiedViewConverter.xml b/xml/System.Windows.Navigation/JournalEntryUnifiedViewConverter.xml index f6323101b12..b31038cb299 100644 --- a/xml/System.Windows.Navigation/JournalEntryUnifiedViewConverter.xml +++ b/xml/System.Windows.Navigation/JournalEntryUnifiedViewConverter.xml @@ -43,9 +43,9 @@ The navigation history is stored by both and in the following properties: - **Back Navigation History**: , . + **Back Navigation History**: , . - **Forward Navigation History**: , . + **Forward Navigation History**: , . To create the drop-down list, and use to merge their individual back navigation history and forward navigation history into a single list of navigation history entries. The resulting list contains up to nine entries from back navigation history and up to nine entries from forward navigation history, plus an entry for the current content. @@ -140,15 +140,15 @@ ## Remarks For , the navigation stacks are available from the following properties: -- +- -- +- For , the navigation stacks are available from the following properties: -- +- - + The two passed navigation stacks are combined into a single navigation stack that contains up to nine items from each navigation stack plus the current item. @@ -268,11 +268,11 @@ object from a navigator (, ), call **RemoveBackEntry**: , , . + To get a single object from a navigator (, ), call **RemoveBackEntry**: , , . - To get all objects from a , enumerate the entries that are returned by and . + To get all objects from a , enumerate the entries that are returned by and . - To get all objects from a , enumerate the entries that are returned by and . + To get all objects from a , enumerate the entries that are returned by and . ## XAML Attribute Usage Members of this class are either not typically used in XAML, or cannot be used in XAML. diff --git a/xml/System.Windows.Navigation/NavigatingCancelEventArgs.xml b/xml/System.Windows.Navigation/NavigatingCancelEventArgs.xml index f957fe8897e..2888dfc668d 100644 --- a/xml/System.Windows.Navigation/NavigatingCancelEventArgs.xml +++ b/xml/System.Windows.Navigation/NavigatingCancelEventArgs.xml @@ -39,17 +39,17 @@ encapsulates the following details of the navigation request: -- **Navigation Initiation**: , , . +- **Navigation Initiation**: , , . -- **Navigation Content**: , . +- **Navigation Content**: , . -- **Navigation Request**: . +- **Navigation Request**: . -- **Navigation State**: , , . +- **Navigation State**: , , . This information allows you to both evaluate the nature of the navigation request, and view and update specified request details before navigation occurs. - Based on the navigation request information provided by , or based on application-specific state or code, you can completely prevent navigation by setting the property to `true` (by default, is `false`). + Based on the navigation request information provided by , or based on application-specific state or code, you can completely prevent navigation by setting the property to `true` (by default, is `false`). @@ -102,7 +102,7 @@ and , contains a reference to the content object that is being navigated to. Additionally, the property will be `null`. + You can navigate to content using either a uniform resource identifier (URI) or an object. When navigating to an object, which occurs when calling and , contains a reference to the content object that is being navigated to. Additionally, the property will be `null`. ]]> @@ -148,7 +148,7 @@ event is raised when navigating from one piece of content to another. The content that is being navigated from is added to back navigation history. You can set with a custom object to associate state information with content in navigation history. + event is raised when navigating from one piece of content to another. The content that is being navigated from is added to back navigation history. You can set with a custom object to associate state information with content in navigation history. ]]> @@ -190,7 +190,7 @@ can be used to pass context-specific data that is specific to a particular navigation. contains a reference to the object that is passed as the second argument when calling either or . Otherwise, it is `null`. + can be used to pass context-specific data that is specific to a particular navigation. contains a reference to the object that is passed as the second argument when calling either or . Otherwise, it is `null`. ]]> @@ -317,7 +317,7 @@ stores a reference to the navigator that raised this event, the navigator may not have actually initiated the navigation. To determine whether this navigator did initiate the current navigation, inspect the property. + While stores a reference to the navigator that raised this event, the navigator may not have actually initiated the navigation. To determine whether this navigator did initiate the current navigation, inspect the property. ]]> @@ -359,7 +359,7 @@ will contain a object if navigating to content in back or forward navigation history that has a object associated with it. + will contain a object if navigating to content in back or forward navigation history that has a object associated with it. ]]> @@ -401,7 +401,7 @@ and , contains the URI of the content being navigated to. Additionally, the property will be `null`. + You can navigate to content using either an uniform resource identifier (URI) or an object. When navigating to an URI, which occurs when calling and , contains the URI of the content being navigated to. Additionally, the property will be `null`. ]]> @@ -455,13 +455,13 @@ You can both view and modify details. - is `null` when navigation occurs by: + is `null` when navigation occurs by: - Using the control. -- Calling +- Calling -- Setting . +- Setting . - Navigating through HTML content in a . diff --git a/xml/System.Windows.Navigation/NavigationEventArgs.xml b/xml/System.Windows.Navigation/NavigationEventArgs.xml index 6f48aa1e06b..a23eab21000 100644 --- a/xml/System.Windows.Navigation/NavigationEventArgs.xml +++ b/xml/System.Windows.Navigation/NavigationEventArgs.xml @@ -94,11 +94,11 @@ Gets an optional user-defined data object. The data object. - to navigate to a new page, you have the option of passing the method a user-defined data object. That object is then assigned to this property so that you have easy access to the data when you handle the event. - + to navigate to a new page, you have the option of passing the method a user-defined data object. That object is then assigned to this property so that you have easy access to the data when you handle the event. + ]]> @@ -137,11 +137,11 @@ if the navigation was initiated inside the current frame; if the parent navigator is also navigating. - diff --git a/xml/System.Windows.Navigation/NavigationFailedEventArgs.xml b/xml/System.Windows.Navigation/NavigationFailedEventArgs.xml index aaa43d9cced..7d5ab275b6a 100644 --- a/xml/System.Windows.Navigation/NavigationFailedEventArgs.xml +++ b/xml/System.Windows.Navigation/NavigationFailedEventArgs.xml @@ -39,15 +39,15 @@ encapsulates the following details of the failed navigation request: -- **Navigation Initiation**: . +- **Navigation Initiation**: . -- **Navigation Exception**: , . +- **Navigation Exception**: , . -- **Navigation Content**: . +- **Navigation Content**: . -- **Navigation Details**: , . +- **Navigation Details**: , . -- **Navigation State**: . +- **Navigation State**: . ]]> @@ -132,7 +132,7 @@ can be used to pass context-specific data that is specific to a particular navigation. contains a reference to the object that is passed as the second argument when calling either or . Otherwise, it is `null`. + can be used to pass context-specific data that is specific to a particular navigation. contains a reference to the object that is passed as the second argument when calling either or . Otherwise, it is `null`. ]]> diff --git a/xml/System.Windows.Navigation/NavigationService.xml b/xml/System.Windows.Navigation/NavigationService.xml index 4a96828d57e..f4114243bbb 100644 --- a/xml/System.Windows.Navigation/NavigationService.xml +++ b/xml/System.Windows.Navigation/NavigationService.xml @@ -31,16 +31,16 @@ Content can be any type of .NET Framework object and HTML files. In general, however, pages are the preferred as the way to package content for navigation (see ). - Content can be navigated to by providing an instance of an object and calling an overload of the method that accepts an object: + Content can be navigated to by providing an instance of an object and calling an overload of the method that accepts an object: -- -- +- +- - Alternatively, content can be navigated to by passing a relative or absolute URI to one of the method overloads that accepts a URI: + Alternatively, content can be navigated to by passing a relative or absolute URI to one of the method overloads that accepts a URI: -- -- -- +- +- +- When content is navigated to by URI, will return an object that contains the content. @@ -60,23 +60,23 @@ ![Page navigation flow chart](~/add/media/navigationoverviewfigure11.png "Page navigation flow chart") - During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). + During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). - When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in back and forward navigation history, respectively. Also, the most recent entry in back navigation history can be removed by calling . + When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in back and forward navigation history, respectively. Also, the most recent entry in back navigation history can be removed by calling . By default, does not store an instance of a content object in navigation history. Instead, creates a new instance of the content object each time it is navigated to by using navigation history. This behavior is designed to avoid excessive memory consumption when large numbers and large pieces of content are being navigated to. Consequently, the state of the content is not remembered from one navigation to the next. However, WPF provides several techniques by which you can store a piece of state for a piece of content in navigation history. - Using , you can also remember multiple sets of state for a single page instance. + Using , you can also remember multiple sets of state for a single page instance. is a `sealed` class and therefore cannot be instantiated; instead, is used by navigators to enable navigation. In WPF, there are two navigators: and . Visually, XBAPs use Internet Explorer as a navigator, to provide an integrated user experience. Physically, however, XBAPs actually use as the navigator; the property of an XBAP running in Internet Explorer will return a reference to the , and the navigation history that is managed by the is integrated with the navigation history that is managed by Internet Explorer in the following ways: -- When content is navigated to by calling , , and from within an XBAP the relevant navigation history entries are also added to Internet Explorer navigation history. +- When content is navigated to by calling , , and from within an XBAP the relevant navigation history entries are also added to Internet Explorer navigation history. - When entries in the Internet Explorer navigation UI are selected, Internet Explorer causes to navigate back or forwards to the content that is associated with those entries. > [!NOTE] -> A can provide its own navigation history, or use the navigation history of the navigator that hosts it. If provides its own navigation history, it can display its own navigation UI to navigate through the entries in navigation history; those entries are not added to the navigation history of the host navigator (, , browser) and, consequently, cannot be navigated to from the navigation UI of each (see ). +> A can provide its own navigation history, or use the navigation history of the navigator that hosts it. If provides its own navigation history, it can display its own navigation UI to navigate through the entries in navigation history; those entries are not added to the navigation history of the host navigator (, , browser) and, consequently, cannot be navigated to from the navigation UI of each (see ). For more information about XBAP support, see [Frequently asked questions about WPF browser-hosted applications (XBAP)](/dotnet/desktop/wpf/app-development/xbap-faq?view=netframeworkdesktop-4.8). @@ -117,7 +117,7 @@ For more information about XBAP support, see [Frequently asked questions about W , , and are used to help remember multiple sets of state for the current content. + , , and are used to help remember multiple sets of state for the current content. ]]> @@ -157,7 +157,7 @@ For more information about XBAP support, see [Frequently asked questions about W to determine whether there is at least one entry in back navigation history. This property should be inspected before calling ; if is called and there are no entries in back navigation history, an is thrown. + to determine whether there is at least one entry in back navigation history. This property should be inspected before calling ; if is called and there are no entries in back navigation history, an is thrown. > [!NOTE] > that if navigation history is shared by multiple navigators (, ), the most recent entry in back navigation history may not have been added by the for the current navigator. @@ -199,7 +199,7 @@ For more information about XBAP support, see [Frequently asked questions about W to determine whether there is at least one entry in forward navigation history. This property should be inspected before calling ; if is called and there are no entries in forward navigation history, an is thrown. + to determine whether there is at least one entry in forward navigation history. This property should be inspected before calling ; if is called and there are no entries in forward navigation history, an is thrown. ]]> @@ -241,9 +241,9 @@ For more information about XBAP support, see [Frequently asked questions about W - Directly, by setting it to a reference to an object. -- Indirectly, by calling , , or . +- Indirectly, by calling , , or . - Setting initiates a new navigation; since navigation is asynchronous, won't return a value if it is inspected immediately after being set. + Setting initiates a new navigation; since navigation is asynchronous, won't return a value if it is inspected immediately after being set. ]]> @@ -282,7 +282,7 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks The value of the property is not changed until navigation to a different URI has completed successfully. - can be set with a fragment-only URI. + can be set with a fragment-only URI. ]]> @@ -317,7 +317,7 @@ For more information about XBAP support, see [Frequently asked questions about W , which is a whose attribute is set. For example: + By default, a content fragment is content that's contained by a named , which is a whose attribute is set. For example: ```xaml ... @@ -337,7 +337,7 @@ For more information about XBAP support, see [Frequently asked questions about W - The fragment name. - You can handle to override the default WPF fragment implementation with your own custom implementation. If you do so, you need to set to `true`; otherwise, the default WPF fragment processing behavior is applied. + You can handle to override the default WPF fragment implementation with your own custom implementation. If you do so, you need to set to `true`; otherwise, the default WPF fragment processing behavior is applied. You should avoid directly initiating navigation from within a event handler. Since is raised during an existing navigation, initiating a new navigation from a event handler creates a nested navigation that can cause the to be thrown. Instead, you can indirectly initiate navigation by creating an asynchronous work item using the . @@ -402,9 +402,9 @@ For more information about XBAP support, see [Frequently asked questions about W that handles content navigation. WPF has two navigators: and . To process navigation requests and manage navigation lifetime, a navigator uses the WPF navigation service, which is implemented as the class. Content that is hosted by a navigator can get a reference to the navigator's by calling the method. + A navigator has a that handles content navigation. WPF has two navigators: and . To process navigation requests and manage navigation lifetime, a navigator uses the WPF navigation service, which is implemented as the class. Content that is hosted by a navigator can get a reference to the navigator's by calling the method. - returns `null` when the `dependencyObject`: + returns `null` when the `dependencyObject`: - Is a . @@ -425,7 +425,7 @@ For more information about XBAP support, see [Frequently asked questions about W ## Examples - The following example shows how a can retrieve a navigation service by calling . + The following example shows how a can retrieve a navigation service by calling . :::code language="csharp" source="~/snippets/csharp/System.Windows.Navigation/NavigationService/GetNavigationService/ContentUserControl.xaml.cs" id="Snippetgetnavigationservicecode1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Navigation/NavigationService/GetNavigationService/contentusercontrol.xaml.vb" id="Snippetgetnavigationservicecode1"::: @@ -467,7 +467,7 @@ For more information about XBAP support, see [Frequently asked questions about W , the property can be inspected to determine whether there are entries in back navigation history. + Before calling , the property can be inspected to determine whether there are entries in back navigation history. @@ -515,7 +515,7 @@ For more information about XBAP support, see [Frequently asked questions about W , the property can be inspected to determine whether there are entries in forward navigation history. + Before calling , the property can be inspected to determine whether there are entries in forward navigation history. @@ -568,7 +568,7 @@ For more information about XBAP support, see [Frequently asked questions about W - The navigator (, ). -- Additional data, if the navigation was initiated by calling either or . +- Additional data, if the navigation was initiated by calling either or . - Response details (using a object). @@ -645,13 +645,13 @@ For more information about XBAP support, see [Frequently asked questions about W will navigate to the specified by `root` if the following conditions are true: + will navigate to the specified by `root` if the following conditions are true: - The event is not cancelled. - A web request (see ) can be created. - If `root` is `null`, the existing content () is cleared. + If `root` is `null`, the existing content () is cleared. > [!NOTE] > When downloading Web content, you may receive a Web exception (for example, 404: File Not Found). You can handle such exceptions from . @@ -715,18 +715,18 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks The value of `source` can be a Web URL or a valid pack URI (see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf)). - will navigate to the URI specified by `source` if the following conditions are true: + will navigate to the URI specified by `source` if the following conditions are true: - The event is not cancelled. - A web request (see ) can be created. - If `source` is `null`, the existing content () is cleared. + If `source` is `null`, the existing content () is cleared. > [!NOTE] > When downloading Web content, you may receive a Web exception (for example, 404: File Not Found). You can handle such exceptions from . - You can use to navigate to a content fragment. If the content identified by the URI is the current content, it is not downloaded again. + You can use to navigate to a content fragment. If the content identified by the URI is the current content, it is not downloaded again. @@ -781,7 +781,7 @@ For more information about XBAP support, see [Frequently asked questions about W , although an object is passed instead of a URI. + This method has the same behavior as , although an object is passed instead of a URI. @@ -846,9 +846,9 @@ For more information about XBAP support, see [Frequently asked questions about W The following event arguments provide access to navigation state: -- (passed to the event). +- (passed to the event). -- (passed to the , , event handlers). +- (passed to the , , event handlers). @@ -913,7 +913,7 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks This method is only for standalone applications and Extensible Application Markup Language (XAML) content. - This method exhibits the same behavior as , and extends it by ensuring that the content that is being downloaded is placed into a partial trust security sandbox (with the default Internet zone set of permissions - see [WPF Partial Trust Security](/dotnet/framework/wpf/wpf-partial-trust-security)). + This method exhibits the same behavior as , and extends it by ensuring that the content that is being downloaded is placed into a partial trust security sandbox (with the default Internet zone set of permissions - see [WPF Partial Trust Security](/dotnet/framework/wpf/wpf-partial-trust-security)). ]]> @@ -960,7 +960,7 @@ For more information about XBAP support, see [Frequently asked questions about W - The navigator (, ). -- Additional data, if the navigation was initiated by calling either or . +- Additional data, if the navigation was initiated by calling either or . - Response details (using a object). @@ -1018,9 +1018,9 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks is raised when a new navigation is requested, but before the source content is requested, including when: -- is called. +- is called. -- or is called (or an entry is selected from a navigation UI). +- or is called (or an entry is selected from a navigation UI). - A content fragment is navigated to. @@ -1028,12 +1028,12 @@ For more information about XBAP support, see [Frequently asked questions about W A object for the navigation is created and available from the parameter; because the actual request hasn't been made at this point, you can reconfigure the object, if necessary. - You also handle to cancel navigation, if required, by setting to true. If you cancel navigation, no other navigation events are raised. + You also handle to cancel navigation, if required, by setting to true. If you cancel navigation, no other navigation events are raised. > [!NOTE] > If your application is hosted in the browser, you cannot prevent the user from navigating away from your application by canceling the event. - After the first piece of content is navigated to by a navigator (, ), each piece of content that is navigated away from is added to navigation history. If you need to save state information about the content you are navigating away from, you can add the state to the journal entry for that content by setting with a object. + After the first piece of content is navigated to by a navigator (, ), each piece of content that is navigated away from is added to navigation history. If you need to save state information about the content you are navigating away from, you can add the state to the journal entry for that content by setting with a object. > [!NOTE] > When raises , it also raises event on the object. @@ -1153,15 +1153,15 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks is passed a which exposes the following progress information: -- Number of bytes downloaded so far (). +- Number of bytes downloaded so far (). -- Number of total bytes to download (). +- Number of total bytes to download (). is raised once for every 1024 bytes of content downloaded, and once more if the number of remaining bytes is ever less than 1024 bytes. For this reason, handling provides a useful way to track and display the progress of a current download. won't be raised in some cases, such as when the same piece of content is navigated to, or when a content fragment is navigated to on content that is currently loaded (that is, the value of the property). - When navigating to a compiled XAML resource, the final event may not be raised. This means that at the end of the download, the last reported value may not equal the value. Handle the event to be notified when the navigation has finished. + When navigating to a compiled XAML resource, the final event may not be raised. This means that at the end of the download, the last reported value may not equal the value. Handle the event to be notified when the navigation has finished. > [!NOTE] > When raises , it also raises event on the object. @@ -1219,7 +1219,7 @@ For more information about XBAP support, see [Frequently asked questions about W - The navigator (, ). -- Additional data, if the navigation was initiated by calling either or . +- Additional data, if the navigation was initiated by calling either or . > [!NOTE] > When raises , it also raises event on the object. @@ -1272,9 +1272,9 @@ For more information about XBAP support, see [Frequently asked questions about W property) is navigated to again, does not download the content again. To force to re-navigate to the content, call . + If the current content (specified by the value of the property) is navigated to again, does not download the content again. To force to re-navigate to the content, call . - Note that if the current content is navigated to again, whether by calling or , a new entry is not added to navigation history. + Note that if the current content is navigated to again, whether by calling or , a new entry is not added to navigation history. ]]> @@ -1312,7 +1312,7 @@ For more information about XBAP support, see [Frequently asked questions about W , ) share the same navigation history, one navigator can use to retrieve the back navigation history entry for a navigation that took place in another navigator. + If two or more navigators (, ) share the same navigation history, one navigator can use to retrieve the back navigation history entry for a navigation that took place in another navigator. ]]> @@ -1351,9 +1351,9 @@ For more information about XBAP support, see [Frequently asked questions about W ## Remarks If you set this property to a different URI than the one currently being displayed, the navigator (, ) navigates to the specified URI. - is set to the content that is loaded from the URI that is navigated to, unless the navigation is canceled. + is set to the content that is loaded from the URI that is navigated to, unless the navigation is canceled. - can be set with a fragment-only URI, and can be set to `null`. + can be set with a fragment-only URI, and can be set to `null`. ]]> @@ -1395,14 +1395,14 @@ For more information about XBAP support, see [Frequently asked questions about W can be called as soon as returns, and stops navigation that is in progress in child frames. + can be called as soon as returns, and stops navigation that is in progress in child frames. (). - Calling the method raises the event. + Calling the method raises the event. > [!NOTE] -> must be called on the same thread that initiated the navigation. +> must be called on the same thread that initiated the navigation. diff --git a/xml/System.Windows.Navigation/NavigationWindow.xml b/xml/System.Windows.Navigation/NavigationWindow.xml index 63bf9de0590..8880ea22750 100644 --- a/xml/System.Windows.Navigation/NavigationWindow.xml +++ b/xml/System.Windows.Navigation/NavigationWindow.xml @@ -51,22 +51,22 @@ Content can be any .NET Framework object or HTML file. In general, however, a object is the preferred way to package content for navigation. - Content can be navigated to by setting the property with the URI for the desired content. Additionally, content can be navigated to by using one of the following overloads of the method: + Content can be navigated to by setting the property with the URI for the desired content. Additionally, content can be navigated to by using one of the following overloads of the method: -- +- -- +- When content is navigated to by URI, will return an object that contains the content. > [!NOTE] > Navigation by URI also supports navigation to a content fragment. See . - Alternatively, content can be navigated to by using one of the method overloads that accepts an object: + Alternatively, content can be navigated to by using one of the method overloads that accepts an object: -- +- -- +- The lifetime of a navigation can be tracked through the following events: @@ -90,17 +90,17 @@ ![Page navigation flow chart](~/add/media/navigationoverviewfigure11.png "Page navigation flow chart") - During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). + During or after a navigation, provides information about the content that is being navigated to, including the URI of the content being navigated to (), the URI of the current content (), and an object that contains the content that was navigated to (). - When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in backward and forward navigation history, respectively. + When content is navigated to, records the navigation as an entry in navigation history. An entry is added to back navigation history when either a new navigation occurs, by calling the method, or by navigating to an entry in forward navigation history, by calling . An entry is added to forward navigation history by navigating to an entry in back navigation history, by calling . and report whether there are entries in backward and forward navigation history, respectively. The first time that one piece of content is navigated to from another piece of content, automatically displays a navigation UI that allows users to navigate back and forwards through navigation history. You can configure when the navigation UI is shown by setting the property. - The most recent entry in back navigation history can be removed by calling . + The most recent entry in back navigation history can be removed by calling . does not store an instance of a content object in navigation history. Instead, creates a new instance of the content object each time it is navigated to by using navigation history. This behavior is designed to avoid excessive memory consumption when large numbers and large pieces of content are being navigated to. Consequently, the state of the content is not remembered from one navigation to the next. However, WPF provides several techniques by which you can store a piece of state for a piece of content in navigation history. - Using , you can also remember multiple sets of state for a single page instance. + Using , you can also remember multiple sets of state for a single page instance. is one of two navigators in WPF, the other being . Essentially, navigator is a class that supports navigation and navigation history. Visually, XBAPs use Internet Explorer as a navigator, to provide an integrated user experience. However, XBAPs actually use as the navigator; the property of an XBAP running in Internet Explorer will return a reference to the , and the navigation history that is managed by the is integrated with the navigation history that's managed by Internet Explorer. @@ -183,7 +183,7 @@ . + See . ]]> @@ -290,14 +290,14 @@ include whole content, fragment navigations, and custom state. + The entries that are returned by include whole content, fragment navigations, and custom state. ## Dependency Property Information | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -365,14 +365,14 @@ . + See . ## Dependency Property Information | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -447,7 +447,7 @@ | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -515,7 +515,7 @@ . + See . ]]> @@ -552,14 +552,14 @@ include whole content, fragment navigations, and custom state. + The entries that are returned by include whole content, fragment navigations, and custom state. ## Dependency Property Information | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -801,7 +801,7 @@ . + See . @@ -856,7 +856,7 @@ . + See . > [!NOTE] > Uniform resource identifiers (URIs) can be either relative or absolute. For more information, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). @@ -864,7 +864,7 @@ ## Examples - The following example shows how to use the method to navigate to a uniform resource identifier (URI). + The following example shows how to use the method to navigate to a uniform resource identifier (URI). :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/Navigate/MainWindow.xaml.cs" id="Snippetnavigatetopagenavcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/Navigate/mainwindow.xaml.vb" id="Snippetnavigatetopagenavcode"::: @@ -916,7 +916,7 @@ . + See . ]]> @@ -965,7 +965,7 @@ . + See . ]]> @@ -1174,7 +1174,7 @@ ## Remarks uses a to provide navigation services to content that is hosted by . The property is useful for code in a custom to get a reference to the , to handle navigation events, for example. - Content that is hosted by a , such as , should use the method or property to get a reference to the . + Content that is hosted by a , such as , should use the method or property to get a reference to the . ]]> @@ -1290,7 +1290,7 @@ releases the object that it is using to manage navigation, before raising event. + releases the object that it is using to manage navigation, before raising event. ]]> @@ -1327,7 +1327,7 @@ . + This method overrides . ]]> @@ -1366,12 +1366,12 @@ . + See . ## Examples - The following example shows how to call the method to reload the content in a . + The following example shows how to call the method to reload the content in a . :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/Navigate/MainWindow.xaml.cs" id="Snippetnavigaterefreshcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/Navigate/mainwindow.xaml.vb" id="Snippetnavigaterefreshcode"::: @@ -1414,7 +1414,7 @@ . + See . ]]> @@ -1454,7 +1454,7 @@ ## Remarks External content is XAML content that is not included with an application as either a resource file or a content file (for more information, see [WPF Application Resource, Content, and Data Files](/dotnet/framework/wpf/app-development/wpf-application-resource-content-and-data-files)). - When is true, and the content of the is an external XAML file, the content is loaded into a partial trust security sandbox that is limited to the default Internet zone permission set. Additionally, the external content is loaded into a separate process. Consequently, the external content becomes isolated and does not have access to application-scope resources, such as resource dictionaries (for more information, see ). + When is true, and the content of the is an external XAML file, the content is loaded into a partial trust security sandbox that is limited to the default Internet zone permission set. Additionally, the external content is loaded into a separate process. Consequently, the external content becomes isolated and does not have access to application-scope resources, such as resource dictionaries (for more information, see ). > [!NOTE] > contains external content only when the property is set to the uniform resource identifier (URI) for an external XAML file. content that is provided using the property is considered internal content and, subsequently, is not isolated. @@ -1464,7 +1464,7 @@ | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -1583,7 +1583,7 @@ | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| +|Identifier field|| |Metadata properties set to `true`|None| ]]> @@ -1654,7 +1654,7 @@ . + See . > [!NOTE] > Uniform resource identifiers (URIs) can be either relative or absolute. For more information, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). @@ -1664,8 +1664,8 @@ | Item | Value | |--------------------------|-----------------------------------------| -|Identifier field|| -|Metadata properties set to `true`|| +|Identifier field|| +|Metadata properties set to `true`|| @@ -1740,14 +1740,14 @@ stops the download of the requested content, and causes the event to be raised. + stops the download of the requested content, and causes the event to be raised. - See . + See . ## Examples - The following example shows how to call the method to stop navigation to content before it has finished being downloaded. + The following example shows how to call the method to stop navigation to content before it has finished being downloaded. :::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Frame/Navigate/MainWindow.xaml.cs" id="Snippetnavigatestoploadingcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Controls/Frame/Navigate/mainwindow.xaml.vb" id="Snippetnavigatestoploadingcode"::: diff --git a/xml/System.Windows.Navigation/PageFunctionBase.xml b/xml/System.Windows.Navigation/PageFunctionBase.xml index b194592dcd8..5a639d89417 100644 --- a/xml/System.Windows.Navigation/PageFunctionBase.xml +++ b/xml/System.Windows.Navigation/PageFunctionBase.xml @@ -24,11 +24,11 @@ An abstract base class that is the parent of all page function classes. - derives from . - + derives from . + ]]> @@ -95,11 +95,11 @@ Gets or sets a value that indicates whether the page function should not be added to navigation history. A that indicates whether a page function should not be added to navigation history. The default value is . - must be called for to be applied. - + must be called for to be applied. + ]]> @@ -131,11 +131,11 @@ Override this method to initialize a when it is navigated to for the first time. - is later reactivated. - + is later reactivated. + ]]> diff --git a/xml/System.Windows.Navigation/PageFunction`1.xml b/xml/System.Windows.Navigation/PageFunction`1.xml index 3e3ae72f57f..c71c987b18f 100644 --- a/xml/System.Windows.Navigation/PageFunction`1.xml +++ b/xml/System.Windows.Navigation/PageFunction`1.xml @@ -31,25 +31,25 @@ essentially allows you to treat a page navigation like a function call, in which a page navigates to (calls) a page function. + essentially allows you to treat a page navigation like a function call, in which a page navigates to (calls) a page function. - To enable function call semantics, provides the following capabilities: + To enable function call semantics, provides the following capabilities: -- When the page function has finished processing, the page function code calls to return to the calling page. +- When the page function has finished processing, the page function code calls to return to the calling page. -- accepts a parameter, which can be used to return a value by settings the property. Otherwise, null can be passed to to signify no value is returned +- accepts a parameter, which can be used to return a value by settings the property. Otherwise, null can be passed to to signify no value is returned -- To detect when a page function has returned, the calling page can handle the event. +- To detect when a page function has returned, the calling page can handle the event. -- To return a value, the page function creates an instance of the class and sets the property with the return value. The calling page can retrieve this value from the object that is passed to the event handler. +- To return a value, the page function creates an instance of the class and sets the property with the return value. The calling page can retrieve this value from the object that is passed to the event handler. - By default, a is retained in navigation history after it returns. To ensure that it is not retained in navigation history, its property should be set to `true`. + By default, a is retained in navigation history after it returns. To ensure that it is not retained in navigation history, its property should be set to `true`. See [Structured Navigation Overview](/dotnet/framework/wpf/app-development/structured-navigation-overview) for details on how to use page functions. See [Navigation Topologies Overview](/dotnet/framework/wpf/app-development/navigation-topologies-overview) for information on complex navigation structures that benefit from page functions. - enables the development of wizards. + enables the development of wizards. ]]> @@ -83,7 +83,7 @@ is not being kept alive (see ), it needs to implement a parameterless constructor to allow WPF to create a new instance of it when navigated to in back or forward navigation history. + If a is not being kept alive (see ), it needs to implement a parameterless constructor to allow WPF to create a new instance of it when navigated to in back or forward navigation history. ]]> @@ -123,18 +123,18 @@ is called by a to initiate a navigation to the calling page. + is called by a to initiate a navigation to the calling page. - This causes the event to be raised, in order for the calling page to: + This causes the event to be raised, in order for the calling page to: -- Detect when the has returned. +- Detect when the has returned. -- Retrieve the return value from the . +- Retrieve the return value from the . ## Examples - The following example shows how to call . + The following example shows how to call . :::code language="csharp" source="~/snippets/csharp/System.Windows.Navigation/PageFunctionT/OnReturn/GetStringPageFunction.xaml.cs" id="Snippetcallonreturncode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Navigation/PageFunctionT/OnReturn/getstringpagefunction.xaml.vb" id="Snippetcallonreturncode"::: @@ -174,7 +174,7 @@ returns by handling . Additionally, the calling page can retrieve the return value from the property of the which is passed to the event handler. + A calling page detects when a called returns by handling . Additionally, the calling page can retrieve the return value from the property of the which is passed to the event handler. ## XAML Attribute Usage @@ -186,7 +186,7 @@ ## Examples - The following example shows how to handle the event. + The following example shows how to handle the event. :::code language="csharp" source="~/snippets/csharp/System.Windows.Navigation/PageFunctionT/OnReturn/GetStringPageFunctionCaller.xaml.cs" id="Snippethandlepagefunctionreturncode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Navigation/PageFunctionT/OnReturn/getstringpagefunctioncaller.xaml.vb" id="Snippethandlepagefunctionreturncode"::: diff --git a/xml/System.Windows.Shapes/Line.xml b/xml/System.Windows.Shapes/Line.xml index e48aa2d8df1..d06ec821628 100644 --- a/xml/System.Windows.Shapes/Line.xml +++ b/xml/System.Windows.Shapes/Line.xml @@ -146,7 +146,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -233,7 +233,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -320,7 +320,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | @@ -407,7 +407,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Shapes/Path.xml b/xml/System.Windows.Shapes/Path.xml index 327a6e8b39a..3ebe54ff606 100644 --- a/xml/System.Windows.Shapes/Path.xml +++ b/xml/System.Windows.Shapes/Path.xml @@ -146,7 +146,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Shapes/Polygon.xml b/xml/System.Windows.Shapes/Polygon.xml index c1fdf72a629..ff5b372a86a 100644 --- a/xml/System.Windows.Shapes/Polygon.xml +++ b/xml/System.Windows.Shapes/Polygon.xml @@ -151,7 +151,7 @@ FillRule Example | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -224,7 +224,7 @@ FillRule Example | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Shapes/Polyline.xml b/xml/System.Windows.Shapes/Polyline.xml index 656a2347e1f..05230c8449e 100644 --- a/xml/System.Windows.Shapes/Polyline.xml +++ b/xml/System.Windows.Shapes/Polyline.xml @@ -151,7 +151,7 @@ FillRule Example | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -225,7 +225,7 @@ FillRule Example | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, | +|Metadata properties set to `true`|, | diff --git a/xml/System.Windows.Shapes/Rectangle.xml b/xml/System.Windows.Shapes/Rectangle.xml index 6e3f103239b..c523e4e30d2 100644 --- a/xml/System.Windows.Shapes/Rectangle.xml +++ b/xml/System.Windows.Shapes/Rectangle.xml @@ -262,7 +262,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -340,7 +340,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows.Shapes/Shape.xml b/xml/System.Windows.Shapes/Shape.xml index 6d5b2020a0c..db6a4340dc8 100644 --- a/xml/System.Windows.Shapes/Shape.xml +++ b/xml/System.Windows.Shapes/Shape.xml @@ -163,7 +163,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, f | +|Metadata properties set to `true`|, f | @@ -428,7 +428,7 @@ | Item | Value | |--------------------------|-----------------------------------------| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | ]]> @@ -660,7 +660,7 @@ or that has no start or end points. For example, this property has no effect if you set it on an . + This property has no effect if you set it on a shape that has no or that has no start or end points. For example, this property has no effect if you set it on an . ]]> @@ -900,7 +900,7 @@ or that has no start or end points. For example, this property has no effect if you set it on an . + This property has no effect if you set it on a shape that has no or that has no start or end points. For example, this property has no effect if you set it on an . ]]> diff --git a/xml/System.Windows.Shell/JumpList.xml b/xml/System.Windows.Shell/JumpList.xml index 02a25d814c7..b77ba7a3675 100644 --- a/xml/System.Windows.Shell/JumpList.xml +++ b/xml/System.Windows.Shell/JumpList.xml @@ -51,27 +51,27 @@ Windows Media Player Jump List ## Configuring a Jump List - Jump Lists can contain two types of items, a and a . A is a link to a program and a is a link to a file. You can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. + Jump Lists can contain two types of items, a and a . A is a link to a program and a is a link to a file. You can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. > [!NOTE] > If the type of the file specified in a is not registered with your application, the file will not appear in the Jump List. For example, if you add a that points to a .txt file, your application must be registered to handle .txt files. For more information, see [Introduction to File Associations](https://go.microsoft.com/fwlink/?LinkId=178480). - Jump items are placed into categories in the . By default, a is displayed in the **Tasks** category. Alternatively, you can specify a for the . + Jump items are placed into categories in the . By default, a is displayed in the **Tasks** category. Alternatively, you can specify a for the . - You can specify whether the standard **Recent** and **Frequent** categories are displayed in the by setting the and properties. The contents of these categories are managed by the Windows shell. Because these categories might contain much of the same data, you typically display one or the other in your , but not both. Windows automatically manages recent items if they are opened through a common file dialog box or used to open an application through file type association. When an item is accessed through the Jump List, you can notify the Windows shell to add the item to the **Recent** category by calling the method. + You can specify whether the standard **Recent** and **Frequent** categories are displayed in the by setting the and properties. The contents of these categories are managed by the Windows shell. Because these categories might contain much of the same data, you typically display one or the other in your , but not both. Windows automatically manages recent items if they are opened through a common file dialog box or used to open an application through file type association. When an item is accessed through the Jump List, you can notify the Windows shell to add the item to the **Recent** category by calling the method. ## Applying a Jump List to the Windows Shell You cannot access the shell's Jump List directly or read its contents into the class. Instead, the class provides a representation of a Jump List that you can work with, and then apply to the Windows shell. You typically create a and set it one time when the application is first run. However, you can modify or replace the at run time. - When you have set the properties, you must apply the to the Windows shell before its contents appear in the taskbar Jump List. This is done automatically when the is first attached to an application, either in XAML or in a call to the method. If you modify the contents of the at run time, you must call the method to apply its current contents to the Windows shell. + When you have set the properties, you must apply the to the Windows shell before its contents appear in the taskbar Jump List. This is done automatically when the is first attached to an application, either in XAML or in a call to the method. If you modify the contents of the at run time, you must call the method to apply its current contents to the Windows shell. ## Setting a Jump List in XAML A is not automatically attached to an object. You attach a to an object in XAML by using the attached property syntax. The class implements the interface to support XAML declaration of a . If the is declared in XAML and attached to the current , it is automatically applied to the Windows shell when the is initialized. ## Setting and Modifying a Jump List in Code - You attach a to an object in code by calling the static method. This also applies the to the Windows shell. + You attach a to an object in code by calling the static method. This also applies the to the Windows shell. - To modify a at run time, you call the method to get the that is currently attached to an . After you have modified the properties of the , you must call the method to apply the changes to the Windows shell. + To modify a at run time, you call the method to get the that is currently attached to an . After you have modified the properties of the , you must call the method to apply the changes to the Windows shell. > [!NOTE] > You typically create one that is attached to the and applied to the Windows shell. However, you can create multiple objects. Only one at a time can be applied to the Windows shell, and only one at a time can be associated with an . The .NET Framework does not require that these be the same . @@ -96,7 +96,7 @@ Windows Media Player Jump List :::code language="xaml" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml" id="Snippet300"::: - The following example shows the code-behind page for `MainWindow.xaml`. This code demonstrates how to modify, clear, and create a in procedural code. For the new Jump List, the static method is called to associate the with the current application and apply the to the Windows shell. + The following example shows the code-behind page for `MainWindow.xaml`. This code demonstrates how to modify, clear, and create a in procedural code. For the new Jump List, the static method is called to associate the with the current application and apply the to the Windows shell. :::code language="csharp" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml.cs" id="Snippet200"::: @@ -240,7 +240,7 @@ Windows Media Player Jump List ## Remarks The contents of the **Recent** category are managed by the Windows shell. To display recently used items in the Jump List, set the property to `true`. - You can call the method to request that the Windows shell add an item path to the **Recent** items list. If your application is not registered to handle the file type of the item, it will not appear in the **Recent** list and calls to will fail silently. + You can call the method to request that the Windows shell add an item path to the **Recent** items list. If your application is not registered to handle the file type of the item, it will not appear in the **Recent** list and calls to will fail silently. ]]> @@ -287,7 +287,7 @@ Windows Media Player Jump List ## Remarks The contents of the **Recent** category are managed by the Windows shell. To display recently used items in the Jump List, set the property to `true`. - You can call the method to request that the Windows shell add the specified jump path to the **Recent** items list. If your application is not registered to handle the file type of the item, it will not appear in the **Recent** list and calls to will fail silently. + You can call the method to request that the Windows shell add the specified jump path to the **Recent** items list. If your application is not registered to handle the file type of the item, it will not appear in the **Recent** list and calls to will fail silently. ]]> @@ -334,7 +334,7 @@ Windows Media Player Jump List ## Remarks The contents of the **Recent** category are managed by the Windows shell. To display recently used items in the Jump List, set the property to `true`. - You can call the method to request that the Windows shell add the specified jump task to the **Recent** items list. + You can call the method to request that the Windows shell add the specified jump task to the **Recent** items list. ]]> @@ -376,12 +376,12 @@ Windows Media Player Jump List method sends the content of the to the Windows shell in its current state. After this call is complete, the property is modified to contain only those items that the Windows shell successfully added to its taskbar Jump List. You can access the lists of removed items through event handlers for the and events. + The method sends the content of the to the Windows shell in its current state. After this call is complete, the property is modified to contain only those items that the Windows shell successfully added to its taskbar Jump List. You can access the lists of removed items through event handlers for the and events. ## Examples - The following example shows how to get the current and clear the contents of the collection. The method is then called to apply the changes to the Windows shell. This example is part of a larger example available in the class overview. + The following example shows how to get the current and clear the contents of the collection. The method is then called to apply the changes to the Windows shell. This example is part of a larger example available in the class overview. :::code language="csharp" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml.cs" id="Snippet230"::: @@ -432,7 +432,7 @@ Windows Media Player Jump List class implements the interface to support XAML declaration of a . The method is only called when the is declared in XAML and attached to an by using the attached property syntax. You do not call this method from your code. + The class implements the interface to support XAML declaration of a . The method is only called when the is declared in XAML and attached to an by using the attached property syntax. You do not call this method from your code. ]]> @@ -481,9 +481,9 @@ Windows Media Player Jump List class implements the interface to support XAML declaration of a . The method is only called when the is declared in XAML and attached to an by using the attached property syntax. You do not call this method from your code. + The class implements the interface to support XAML declaration of a . The method is only called when the is declared in XAML and attached to an by using the attached property syntax. You do not call this method from your code. - The method has the same effect as the method. sends the content of the to the Windows shell in its current state. After this call is complete, the property is modified to contain only those items that the Windows shell successfully added to its Jump List. You can access the lists of removed items through event handlers for the and events. + The method has the same effect as the method. sends the content of the to the Windows shell in its current state. After this call is complete, the property is modified to contain only those items that the Windows shell successfully added to its Jump List. You can access the lists of removed items through event handlers for the and events. ]]> @@ -523,12 +523,12 @@ Windows Media Player Jump List method to get the currently associated with an . The .NET Framework does not require that this be the that is currently applied to the Windows shell. + You can call the method to get the currently associated with an . The .NET Framework does not require that this be the that is currently applied to the Windows shell. ## Examples - The following example shows how to get the associated with the current application. A is added to the collection and added to the **Recent** category. The method is called to apply the updated to the Windows shell. This example is part of a larger example available in the class overview. + The following example shows how to get the associated with the current application. A is added to the collection and added to the **Recent** category. The method is called to apply the updated to the Windows shell. This example is part of a larger example available in the class overview. :::code language="csharp" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml.cs" id="Snippet240"::: @@ -573,12 +573,12 @@ Windows Media Player Jump List ## Remarks Jump Lists can contain two types of items, a and a . A is a link to a program and a is a link to a file. - When a is created, the collection is empty. You can add any or objects to the collection. The collection will only contain items that have been added by your program. After the has been passed to the Windows shell by a successful call to either the or methods, the collection will contain only the items that were successfully added to the taskbar Jump List. Items that were not successfully added are removed from the collection. You can access the lists of removed items through event handlers for the and events. + When a is created, the collection is empty. You can add any or objects to the collection. The collection will only contain items that have been added by your program. After the has been passed to the Windows shell by a successful call to either the or methods, the collection will contain only the items that were successfully added to the taskbar Jump List. Items that were not successfully added are removed from the collection. You can access the lists of removed items through event handlers for the and events. ## Examples - The following example shows how to get the current and clear the contents of the collection. The method is then called to apply the changes to the Windows shell. This example is part of a larger example available in the class overview. + The following example shows how to get the current and clear the contents of the collection. The method is then called to apply the changes to the Windows shell. This example is part of a larger example available in the class overview. :::code language="csharp" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml.cs" id="Snippet230"::: @@ -710,12 +710,12 @@ Windows Media Player Jump List objects. However, only one at a time can be associated with an . Call the method to set the currently associated with an . + You can create multiple objects. However, only one at a time can be associated with an . Call the method to set the currently associated with an . ## Examples - The following example shows how to create a in code. The static method is called to associate the with the current application. The is automatically applied to the Windows shell when it is set. This example is part of a larger example available in the class overview. + The following example shows how to create a in code. The static method is called to associate the with the current application. The is automatically applied to the Windows shell when it is set. This example is part of a larger example available in the class overview. :::code language="csharp" source="~/snippets/csharp/System.Windows.Shell/JumpList/Overview/mainwindow.xaml.cs" id="Snippet210"::: @@ -838,7 +838,7 @@ Windows Media Player Jump List The **Recent** and **Frequent** categories often contain many of the same jump items. As a result, applications typically display either the **Recent** or the **Frequent** category in the Jump List, but not both. - You can call the method to request that the Windows shell add items to the **Recent** items list. If your application is not registered to handle the file name type of the item, it will not appear in the **Recent** list and calls to will fail silently. + You can call the method to request that the Windows shell add items to the **Recent** items list. If your application is not registered to handle the file name type of the item, it will not appear in the **Recent** list and calls to will fail silently. diff --git a/xml/System.Windows.Shell/JumpTask.xml b/xml/System.Windows.Shell/JumpTask.xml index c3ee8d42daa..57a8f0670d1 100644 --- a/xml/System.Windows.Shell/JumpTask.xml +++ b/xml/System.Windows.Shell/JumpTask.xml @@ -26,13 +26,13 @@ can be thought of as a shortcut to an application. You specify the path to the executable file by setting the property. If the is not set, the path of the current running process is implied. You can optionally specify to pass to the application at startup. + A can be thought of as a shortcut to an application. You specify the path to the executable file by setting the property. If the is not set, the path of the current running process is implied. You can optionally specify to pass to the application at startup. - You can set basic display properties, such as , , and to specify the appearance of the task in the Jump List. An icon used with a must be available as a native resource. If multiple icon resources are available in a DLL or executable file, you specify the one to use by indicating an offset in the property. + You can set basic display properties, such as , , and to specify the appearance of the task in the Jump List. An icon used with a must be available as a native resource. If multiple icon resources are available in a DLL or executable file, you specify the one to use by indicating an offset in the property. By default, a will be placed in the **Tasks** category of the Jump List. You can specify custom grouping of tasks by setting the property. - You can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. In this case, other properties can be set, but they will not have any effect. + You can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. In this case, other properties can be set, but they will not have any effect. @@ -395,7 +395,7 @@ ## Remarks Typically, the property must be set for the to appear in the Jump List as a clickable task. - Alternatively, you can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. In this case, other properties can be set, but they will not have any effect. + Alternatively, you can visually separate items in a Jump List by creating a that does not have a and specified. This empty will be displayed as a horizontal line in the Jump List. In this case, other properties can be set, but they will not have any effect. diff --git a/xml/System.Windows.Shell/ResizeGripDirection.xml b/xml/System.Windows.Shell/ResizeGripDirection.xml index d4831164d63..ef85a8ef09f 100644 --- a/xml/System.Windows.Shell/ResizeGripDirection.xml +++ b/xml/System.Windows.Shell/ResizeGripDirection.xml @@ -22,11 +22,11 @@ Specifies constants that indicate the direction of the resize grip behavior on an input element. - attached property. - + attached property. + ]]> diff --git a/xml/System.Windows.Shell/TaskbarItemInfo.xml b/xml/System.Windows.Shell/TaskbarItemInfo.xml index db038a65b38..3744537da5e 100644 --- a/xml/System.Windows.Shell/TaskbarItemInfo.xml +++ b/xml/System.Windows.Shell/TaskbarItemInfo.xml @@ -26,17 +26,17 @@ class provides a managed wrapper for Windows 7 taskbar functionality. For more information about the Windows shell and native taskbar APIs, see [Taskbar Extensions](https://go.microsoft.com/fwlink/?LinkId=178479). is exposed as the dependency property on a . + The class provides a managed wrapper for Windows 7 taskbar functionality. For more information about the Windows shell and native taskbar APIs, see [Taskbar Extensions](https://go.microsoft.com/fwlink/?LinkId=178479). is exposed as the dependency property on a . The Windows 7 taskbar provides enhanced functionality that enables you to use the taskbar item to communicate status to a user and expose common tasks when the window is minimized or hidden. The functionality that is exposed by the class is unavailable in versions of Windows earlier than Windows 7. Applications that use the class can still run in earlier versions of Windows; however, these taskbar enhancements are unavailable in the earlier versions. In Windows 7, some taskbar functionality might be unavailable, depending on the user's settings. For example, taskbar functionality is unavailable if Windows Aero is disabled or if the application is started with elevated permissions. Your application should provide other ways to interact with the user that do not depend on the enhanced taskbar functionality in Windows 7. - Program icons in the notification area, which is at the far right of the taskbar, are typically used to communicate application status to a user. By default, the Windows 7 taskbar hides program icons in the notification area. However, you can set the property to add an image to the taskbar button to communicate status, such as online status in a messaging application. The overlay image lets users see the application status even if they cannot see the program icon in the notification area. You can also display the progress of running tasks in the taskbar button by setting the and properties. + Program icons in the notification area, which is at the far right of the taskbar, are typically used to communicate application status to a user. By default, the Windows 7 taskbar hides program icons in the notification area. However, you can set the property to add an image to the taskbar button to communicate status, such as online status in a messaging application. The overlay image lets users see the application status even if they cannot see the program icon in the notification area. You can also display the progress of running tasks in the taskbar button by setting the and properties. - The Windows 7 taskbar displays a thumbnail of the application when you move the mouse pointer over the taskbar button. By default the whole application window is shown. You can specify a particular part of the window to display in the thumbnail by setting the property. You can also specify a that is displayed in a tooltip above the taskbar thumbnail. The tooltip is displayed even when the thumbnail cannot be seen because of user settings. + The Windows 7 taskbar displays a thumbnail of the application when you move the mouse pointer over the taskbar button. By default the whole application window is shown. You can specify a particular part of the window to display in the thumbnail by setting the property. You can also specify a that is displayed in a tooltip above the taskbar thumbnail. The tooltip is displayed even when the thumbnail cannot be seen because of user settings. - You can add buttons to the taskbar thumbnail to provide access to common tasks without switching to the application window. For example, Window Media Player provides Play, Pause, Forward, and Back buttons that let you control media playback from the taskbar thumbnail when the application is minimized. Buttons in the taskbar thumbnail are represented by objects and are contained in the collection. + You can add buttons to the taskbar thumbnail to provide access to common tasks without switching to the application window. For example, Window Media Player provides Play, Pause, Forward, and Back buttons that let you control media playback from the taskbar thumbnail when the application is minimized. Buttons in the taskbar thumbnail are represented by objects and are contained in the collection. The following illustration shows the enhanced features of the Windows 7 taskbar. @@ -151,7 +151,7 @@ Windows Taskbar Enhanced Features ## Remarks The tooltip is displayed above the taskbar thumbnail when the mouse pointer is over the taskbar button. If the taskbar thumbnail is not displayed because of user settings, the tooltip is still displayed. - The following illustration shows the taskbar tooltip. + The following illustration shows the taskbar tooltip. ![Taskbar Item Info Sample](~/add/media/wpfshell-taskbariteminfo.png "Taskbar Item Info Sample") Windows Taskbar Description @@ -229,7 +229,7 @@ Windows Taskbar Description Overlay images are rendered at the appropriate size. If the represents an , the appropriate bit depth is also used. - The following illustration shows the taskbar . + The following illustration shows the taskbar . ![Taskbar Item Info Sample](~/add/media/wpfshell-taskbariteminfo.png "Taskbar Item Info Sample") Windows Taskbar Overlay @@ -308,7 +308,7 @@ Windows Taskbar Overlay property, which contains one of the enumeration values. When the is , the indicator is green. When , the indicator is yellow. When , the indicator is red. For these states, the property determines how much of the taskbar button is filled by the progress indicator. is ignored for other values of . shows a pulsing green indicator across the entire taskbar button. No indicator is shown for . + You can communicate the progress of long-running tasks by displaying a progress indicator in a Windows 7 taskbar button. The color of the indicator is determined by the property, which contains one of the enumeration values. When the is , the indicator is green. When , the indicator is yellow. When , the indicator is red. For these states, the property determines how much of the taskbar button is filled by the progress indicator. is ignored for other values of . shows a pulsing green indicator across the entire taskbar button. No indicator is shown for . The following illustration shows the taskbar progress indicator in the state. @@ -385,9 +385,9 @@ Windows Taskbar Progress Indicator ## Remarks The property is represented as a value between 0.0 and 1.0. Numbers smaller and larger are coerced to be within those bounds. is coerced to 0. - You can communicate the progress of long-running tasks by displaying a progress indicator in a Windows 7 taskbar button. The color of the indicator is determined by the property, which contains one of the enumeration values. If the property is , , or , the property determines the fullness of the progress indicator. is ignored for some values of . shows a pulsing green indicator across the entire taskbar button. No indicator is shown for . + You can communicate the progress of long-running tasks by displaying a progress indicator in a Windows 7 taskbar button. The color of the indicator is determined by the property, which contains one of the enumeration values. If the property is , , or , the property determines the fullness of the progress indicator. is ignored for some values of . shows a pulsing green indicator across the entire taskbar button. No indicator is shown for . - The following illustration shows the taskbar progress indicator with a of 82 percent. + The following illustration shows the taskbar progress indicator with a of 82 percent. ![Taskbar Item Info Sample](~/add/media/wpfshell-taskbariteminfo.png "Taskbar Item Info Sample") Windows Taskbar Progress Indicator @@ -460,7 +460,7 @@ Windows Taskbar Progress Indicator objects and are contained in the collection. + You can add buttons to the taskbar thumbnail to give users access to common tasks without requiring them to switch to the application window. For example, Windows Media Player provides Play, Pause, Forward, and Back buttons that let users control media playback from the taskbar thumbnail when the application is minimized. Buttons in the taskbar thumbnail are represented by objects and are contained in the collection. The Windows 7 shell allows a maximum of seven buttons in the taskbar thumbnail. If more than seven objects are added to the , the additional objects are treated as overflow. When a button is , it does not have any visible elements, and no space is reserved for it. In this case, additional buttons from the overflow are displayed. @@ -540,7 +540,7 @@ Windows Taskbar Thumb Buttons You specify the area that is displayed in the thumbnail by setting the of the border around the area. The border starts at the edge of the client window and extends inward by the specified amount. Content inside the border is displayed in the thumbnail. - The following illustration shows the borders that define the . + The following illustration shows the borders that define the . ![Thumbnail clip margin](~/add/media/wpfshell-clipmargin.png "Thumbnail clip margin") Thumbnail Clip Margin Border diff --git a/xml/System.Windows.Shell/TaskbarItemProgressState.xml b/xml/System.Windows.Shell/TaskbarItemProgressState.xml index 619c4bb6b66..cd35fac7e1e 100644 --- a/xml/System.Windows.Shell/TaskbarItemProgressState.xml +++ b/xml/System.Windows.Shell/TaskbarItemProgressState.xml @@ -25,7 +25,7 @@ property, which contains one of the enumeration values. If the is Normal, Paused, or Error, the property determines the completeness of the progress indicator. is ignored for other values of . + You can communicate the progress of long-running tasks by displaying a progress indicator in the Windows 7 taskbar. The color of the indicator is determined by the property, which contains one of the enumeration values. If the is Normal, Paused, or Error, the property determines the completeness of the progress indicator. is ignored for other values of . ]]> diff --git a/xml/System.Windows.Shell/ThumbButtonInfo.xml b/xml/System.Windows.Shell/ThumbButtonInfo.xml index b4dc417c4fd..071b2d0b06e 100644 --- a/xml/System.Windows.Shell/ThumbButtonInfo.xml +++ b/xml/System.Windows.Shell/ThumbButtonInfo.xml @@ -32,7 +32,7 @@ ## Remarks The Windows 7 taskbar provides enhanced functionality that enables you to use the taskbar button to communicate status to a user and expose common tasks when the window is minimized or hidden. You can add buttons to the taskbar thumbnail to provide access to common tasks without switching to the application window. For example, Windows Media Player provides Play, Pause, Forward, and Back buttons that you can use to control media playback from the taskbar thumbnail when the application is minimized. - The class contains properties that describe how the Windows 7 shell displays the buttons in the taskbar thumbnail. It provides a managed wrapper around the native Windows API. objects are contained in the collection. + The class contains properties that describe how the Windows 7 shell displays the buttons in the taskbar thumbnail. It provides a managed wrapper around the native Windows API. objects are contained in the collection. The enhanced taskbar functionality is not available in versions of Windows earlier than Windows 7. In Windows 7, some functionality might not be available depending on the user's settings. For example, buttons are only shown in the taskbar thumbnail when Windows Aero is enabled. Your application should provide alternate ways of interacting with the user that are not dependent on the enhanced taskbar functionality. @@ -112,7 +112,7 @@ Windows Taskbar Thumb Buttons event, the event handler executes instead of any that is bound to the thumbnail button. + If you handle the event, the event handler executes instead of any that is bound to the thumbnail button. ]]> @@ -148,14 +148,14 @@ Windows Taskbar Thumb Buttons event, the event handler executes instead of any that is bound to the thumbnail button. + If you handle the event, the event handler executes instead of any that is bound to the thumbnail button. In XAML, this property is often set to be a static command value from one of the existing command libraries, such as from the or library. ## Examples - The following example shows how to create a in markup. The is bound to the command. This example is part of a larger example provided for the class. + The following example shows how to create a in markup. The is bound to the command. This example is part of a larger example provided for the class. :::code language="xaml" source="~/snippets/csharp/System.Windows.Shell/TaskbarItemInfo/Overview/mainwindow.xaml" id="Snippet020"::: @@ -375,7 +375,7 @@ Windows Taskbar Thumb Buttons ## Examples - The following example shows how to create a in markup. The is bound to the command. The tooltip descriptive text is **Stop**. This example is part of a larger example provided for the class. + The following example shows how to create a in markup. The is bound to the command. The tooltip descriptive text is **Stop**. This example is part of a larger example provided for the class. :::code language="xaml" source="~/snippets/csharp/System.Windows.Shell/TaskbarItemInfo/Overview/mainwindow.xaml" id="Snippet020"::: @@ -446,7 +446,7 @@ Windows Taskbar Thumb Buttons ## Examples - The following example shows how to create a in markup. The is bound to the command. It is configured to close when the button is clicked. This example is part of a larger example provided for the class. + The following example shows how to create a in markup. The is bound to the command. It is configured to close when the button is clicked. This example is part of a larger example provided for the class. :::code language="xaml" source="~/snippets/csharp/System.Windows.Shell/TaskbarItemInfo/Overview/mainwindow.xaml" id="Snippet020"::: @@ -517,7 +517,7 @@ Windows Taskbar Thumb Buttons ## Examples - The following example shows how to create a in markup. The is bound to the command. The button image is a dark gray square defined in XAML as a static resource. This example is part of a larger example provided for the class. + The following example shows how to create a in markup. The is bound to the command. The button image is a dark gray square defined in XAML as a static resource. This example is part of a larger example provided for the class. :::code language="xaml" source="~/snippets/csharp/System.Windows.Shell/TaskbarItemInfo/Overview/mainwindow.xaml" id="Snippet020"::: @@ -583,7 +583,7 @@ Windows Taskbar Thumb Buttons , and a highlight is displayed when the mouse pointer is moved over the thumbnail button. To display only the without the border and highlight, set the property to `false`. If is `false`, the still shifts when the thumbnail button is clicked to provide visual feedback to the user. + By default, a border appears around the , and a highlight is displayed when the mouse pointer is moved over the thumbnail button. To display only the without the border and highlight, set the property to `false`. If is `false`, the still shifts when the thumbnail button is clicked to provide visual feedback to the user. ]]> @@ -646,7 +646,7 @@ Windows Taskbar Thumb Buttons property is `false`, the thumbnail button does not respond to events and the is dimmed. + When the property is `false`, the thumbnail button does not respond to events and the is dimmed. ]]> @@ -710,9 +710,9 @@ Windows Taskbar Thumb Buttons property is `false`, the thumbnail button does not respond to events. However, the is not dimmed. You can use a thumbnail button that is not interactive as a status icon. + When the property is `false`, the thumbnail button does not respond to events. However, the is not dimmed. You can use a thumbnail button that is not interactive as a status icon. - If the property is `false`, the setting for does not have any effect. + If the property is `false`, the setting for does not have any effect. ]]> @@ -775,7 +775,7 @@ Windows Taskbar Thumb Buttons . Windows 7 allows a maximum of seven buttons in the taskbar thumbnail. When the property is set to , the thumbnail button has no visible elements, but space is still reserved for it. When the thumbnail button is , it does not have any visible elements and no space is reserved for it. In this case, additional thumbnail buttons in the collection are displayed. + By default, the thumbnail button is . Windows 7 allows a maximum of seven buttons in the taskbar thumbnail. When the property is set to , the thumbnail button has no visible elements, but space is still reserved for it. When the thumbnail button is , it does not have any visible elements and no space is reserved for it. In this case, additional thumbnail buttons in the collection are displayed. ]]> diff --git a/xml/System.Windows.Shell/ThumbButtonInfoCollection.xml b/xml/System.Windows.Shell/ThumbButtonInfoCollection.xml index 669be49ab68..bc990fa3f11 100644 --- a/xml/System.Windows.Shell/ThumbButtonInfoCollection.xml +++ b/xml/System.Windows.Shell/ThumbButtonInfoCollection.xml @@ -26,13 +26,13 @@ Represents a collection of objects that are associated with a . - is a strongly-typed that is used to support declarations in Extensible Application Markup Language (XAML). - - The Windows 7 shell allows a maximum of seven buttons in the taskbar preview. If more than seven objects are added to the , the additional objects are treated as overflow. When a button is , it does not have any visible elements and no space is reserved for it. In this case, additional buttons from the overflow are displayed. - + is a strongly-typed that is used to support declarations in Extensible Application Markup Language (XAML). + + The Windows 7 shell allows a maximum of seven buttons in the taskbar preview. If more than seven objects are added to the , the additional objects are treated as overflow. When a button is , it does not have any visible elements and no space is reserved for it. In this case, additional buttons from the overflow are displayed. + ]]> diff --git a/xml/System.Windows.Shell/WindowChrome.xml b/xml/System.Windows.Shell/WindowChrome.xml index ed3bec258fe..e8531724fda 100644 --- a/xml/System.Windows.Shell/WindowChrome.xml +++ b/xml/System.Windows.Shell/WindowChrome.xml @@ -44,7 +44,7 @@ ### WindowChrome To customize a window while retaining its standard functionality, you can use the class. The class separates the functionality of the window frame from the visuals, and lets you control the boundary between the client and non-client areas of your application window. The class lets you put WPF content in the window frame by extending the client area to cover the non-client area. At the same time, it retains system behaviors through two invisible areas; the *resize border* and *caption* areas. - There are two main parts to creating a custom window using the class. First, you customize the non-client part of the window by setting properties exposed on the object. Then you provide a template for the window that defines the part of your application that is extended into the non-client area. The properties exposed on the object are , , , and . + There are two main parts to creating a custom window using the class. First, you customize the non-client part of the window by setting properties exposed on the object. Then you provide a template for the window that defines the part of your application that is extended into the non-client area. The properties exposed on the object are , , , and . The property specifies an invisible border around the outside of the application window that the user can click-and-drag to resize the window. @@ -61,7 +61,7 @@ To make a custom window that does not have a glass frame, set the property to a uniform value of 0. This will disable and hide the standard caption buttons. - To extend the glass frame to cover the entire window, set the property to a negative value on any side. When the property is set to a negative value for any side, its coerced value will be equal to . + To extend the glass frame to cover the entire window, set the property to a negative value on any side. When the property is set to a negative value for any side, its coerced value will be equal to . > [!NOTE] > Aero is a set of visual enhancements to the look and functionality of the Windows desktop that was introduced in Windows Vista. One of the more visually obvious features of Aero is translucent glass window borders. Windows Aero is enabled by the desktop composition feature of the Desktop Window Manager (DWM). @@ -200,7 +200,7 @@ ## Remarks Set the property to specify the area at the top of the window that enables the system behaviors typically associated with the title bar. These behaviors include double-click to maximize the window, right-click to open the system menu, and click-and-drag to move the window. This property can be set to any non-negative double value. - The area defined by the property starts at the bottom edge of the top resize border and extends downward the specified amount. It spans the width of the window inside the right and left resize borders. This area does not have any visual elements associated with it; it is only used to define the region that responds to the title bar behaviors. By default, the parts of any visual elements that are within the caption area of the window are not interactive. To enable interactive elements in the caption area, attach the attached property to the element and set it to `true`. + The area defined by the property starts at the bottom edge of the top resize border and extends downward the specified amount. It spans the width of the window inside the right and left resize borders. This area does not have any visual elements associated with it; it is only used to define the region that responds to the title bar behaviors. By default, the parts of any visual elements that are within the caption area of the window are not interactive. To enable interactive elements in the caption area, attach the attached property to the element and set it to `true`. ## Dependency Property Information @@ -272,7 +272,7 @@ ## Remarks Set the property to specify the amount of rounding at the corners of a window. This property can be set to any non-negative double value. The values can be non-uniform. - This property does not affect maximized windows or windows that have a Windows Aero glass frame. It only has an effect when Windows Aero (also called Desktop Window Manager) is not enabled or the property is set to 0. Hit testing in the non-client area does not take the into account when determining whether the mouse is over a resize border. If the radius is too large relative to the then it is possible that the user cannot perform a diagonal resize using the mouse. + This property does not affect maximized windows or windows that have a Windows Aero glass frame. It only has an effect when Windows Aero (also called Desktop Window Manager) is not enabled or the property is set to 0. Hit testing in the non-client area does not take the into account when determining whether the mouse is over a resize border. If the radius is too large relative to the then it is possible that the user cannot perform a diagonal resize using the mouse. ## Dependency Property Information @@ -478,7 +478,7 @@ property is provided as a utility to enable you to set the thickness of the glass frame to a named property. You set the property equal to to extend the glass frame over the entire window. If the property is set to a negative value for any side, its coerced value will be equal to . + The property is provided as a utility to enable you to set the thickness of the glass frame to a named property. You set the property equal to to extend the glass frame over the entire window. If the property is set to a negative value for any side, its coerced value will be equal to . ]]> @@ -515,7 +515,7 @@ ## Remarks Set the property to specify the amount that the Windows Aero glass frame extends into the client area of a window. By default, the glass frame will use system values to emulate the look of a standard window. If Windows Aero is enabled, then the standard caption buttons (Maximize, Minimize, Close) are enabled and interactive. To make a custom window that does not have a glass frame, set this thickness to a uniform value of 0. This will disable the standard caption buttons. - To extend the glass frame to cover the entire window, set the property to a negative value on any side. If the property is set to a negative value for any side, its coerced value will be equal to . The property is provided as a utility to enable you to set the thickness of the glass frame to a named property that extends the glass over the entire window. + To extend the glass frame to cover the entire window, set the property to a negative value on any side. If the property is set to a negative value for any side, its coerced value will be equal to . The property is provided as a utility to enable you to set the thickness of the glass frame to a named property that extends the glass over the entire window. Windows Aero glass effects are not supported on all operating systems, and can be disabled on supported operating systems. If Windows Aero is not available, the glass frame will not be displayed regardless of the property value. You should check the property to verify that Windows Aero glass effects are available. If glass effects are not available, you should provide an alternate window style that does not use the glass frame. diff --git a/xml/System.Windows.Threading/Dispatcher.xml b/xml/System.Windows.Threading/Dispatcher.xml index e732597c930..50d85a348d0 100644 --- a/xml/System.Windows.Threading/Dispatcher.xml +++ b/xml/System.Windows.Threading/Dispatcher.xml @@ -32,15 +32,15 @@ When a is created on a thread, it becomes the only that can be associated with the thread, even if the is shut down. - If you attempt to get the for the current thread and a is not associated with the thread, a will be created. A is also created when you create a . If you create a on a background thread, be sure to shut down the dispatcher before exiting the thread. + If you attempt to get the for the current thread and a is not associated with the thread, a will be created. A is also created when you create a . If you create a on a background thread, be sure to shut down the dispatcher before exiting the thread. If a is shut down, it cannot be restarted. - In WPF, a can only be accessed by the it is associated with. For example, a background thread cannot update the contents of a that is associated with the on the UI thread. In order for the background thread to access the property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the queue of the at the specified . + In WPF, a can only be accessed by the it is associated with. For example, a background thread cannot update the contents of a that is associated with the on the UI thread. In order for the background thread to access the property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the queue of the at the specified . - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . - All of the methods on , with the exception of , are free-threaded. + All of the methods on , with the exception of , are free-threaded. Objects that derive from have thread affinity. @@ -56,7 +56,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Overview/Window1.xaml.cs" id="Snippetthreadingprimenumberinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Overview/mainwindow.xaml.vb" id="Snippetthreadingprimenumberinit"::: - Next, is called. This call to takes two parameters: the priority, which is set to , and the callback, which is passed in through an instance of the delegate `NextPrimeDelegate`. + Next, is called. This call to takes two parameters: the priority, which is set to , and the callback, which is passed in through an instance of the delegate `NextPrimeDelegate`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Overview/Window1.xaml.cs" id="Snippetthreadingprimenumberbegininvoke"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Overview/mainwindow.xaml.vb" id="Snippetthreadingprimenumberbegininvoke"::: @@ -77,13 +77,13 @@ may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - returns a object that can be used to interact with the delegate when the delegate is in the event queue. + returns a object that can be used to interact with the delegate when the delegate is in the event queue. - The object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -93,9 +93,9 @@ - Obtaining the value that the delegate returns after it is executed. - If multiple calls are made at the same , they will be executed in the order the calls were made. + If multiple calls are made at the same , they will be executed in the order the calls were made. - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . ]]> @@ -150,7 +150,7 @@ object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -160,11 +160,11 @@ - Obtaining the value that the delegate returns after it is executed. - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . ]]> @@ -220,11 +220,11 @@ calls are made at the same , they will be executed in the order the calls were made. + If multiple calls are made at the same , they will be executed in the order the calls were made. - returns a object that can be used to interact with the delegate when the delegate is in the event queue. + returns a object that can be used to interact with the delegate when the delegate is in the event queue. - The object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -234,11 +234,11 @@ - Obtaining the value that the delegate returns after it is executed. - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . @@ -250,7 +250,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Overview/Window1.xaml.cs" id="Snippetthreadingprimenumberinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Overview/mainwindow.xaml.vb" id="Snippetthreadingprimenumberinit"::: - Next, is called. Because every has a property that returns the it is associated with, the desired is obtained by querying the , in this case a named `startStopButton`. The call to takes two parameters: the priority, which is set to , and the callback, which is passed in through an instance of the delegate `NextPrimeDelegate`. + Next, is called. Because every has a property that returns the it is associated with, the desired is obtained by querying the , in this case a named `startStopButton`. The call to takes two parameters: the priority, which is set to , and the callback, which is passed in through an instance of the delegate `NextPrimeDelegate`. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Overview/Window1.xaml.cs" id="Snippetthreadingprimenumberbegininvoke"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Overview/mainwindow.xaml.vb" id="Snippetthreadingprimenumberbegininvoke"::: @@ -315,7 +315,7 @@ object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -325,11 +325,11 @@ - Obtaining the value that the delegate returns after it is executed. - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . ]]> @@ -389,9 +389,9 @@ ## Remarks `arg` can be `null` if no arguments are needed. - returns a object that can be used to interact with the delegate when the delegate is in the event queue. + returns a object that can be used to interact with the delegate when the delegate is in the event queue. - The object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -401,13 +401,13 @@ - Obtaining the value that the delegate returns after it is executed. - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - If multiple calls are made at the same , they will be executed in the order the calls were made. + If multiple calls are made at the same , they will be executed in the order the calls were made. - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . ## Examples The following example shows how to place an operation onto a . @@ -417,7 +417,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/BeginInvoke/Window1.xaml.cs" id="Snippetthreadingweatherdelegates"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/BeginInvoke/window1.xaml.vb" id="Snippetthreadingweatherdelegates"::: - Next, is called. Because every has a property that returns the it is associated with, the desired is obtained by querying the , in this case a named `tomorrowsWeather`. The call to takes three parameters: the priority, which is set to ; the callback, which is passed in through an instance of the delegate `OneArgDelegate`; and a string named `weather`, which is the argument for the callback. + Next, is called. Because every has a property that returns the it is associated with, the desired is obtained by querying the , in this case a named `tomorrowsWeather`. The call to takes three parameters: the priority, which is set to ; the callback, which is passed in through an instance of the delegate `OneArgDelegate`; and a string named `weather`, which is the argument for the callback. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/BeginInvoke/Window1.xaml.cs" id="Snippetthreadingweatherdispatcheronearge"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/BeginInvoke/window1.xaml.vb" id="Snippetthreadingweatherdispatcheronearge"::: @@ -490,9 +490,9 @@ ## Remarks The `arg` parameter can be `null` if no arguments are needed. - returns a object that can be used to interact with the delegate when the delegate is in the event queue. + returns a object that can be used to interact with the delegate when the delegate is in the event queue. - The object returned by can be used in several ways to interact with the specified delegate, such as: + The object returned by can be used in several ways to interact with the specified delegate, such as: - Changing the of the delegate as it is pending execution in the event queue. @@ -502,13 +502,13 @@ - Obtaining the value that the delegate returns after it is executed. - is asynchronous; therefore, control returns immediately to the calling object after it is called. + is asynchronous; therefore, control returns immediately to the calling object after it is called. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - If multiple calls are made at the same , they will be executed in the order the calls were made. + If multiple calls are made at the same , they will be executed in the order the calls were made. - If is called on a that has shut down, the status property of the returned is set to . + If is called on a that has shut down, the status property of the returned is set to . ]]> @@ -558,9 +558,9 @@ demands unrestricted UI Permissions. + demands unrestricted UI Permissions. - When the starts to shut down, the event is raised and is set to `true`. + When the starts to shut down, the event is raised and is set to `true`. The does not shut down completely until the event queue unwinds. @@ -610,14 +610,14 @@ that a is created on may access the object. Use or to access the object from a different thread. + Only the that a is created on may access the object. Use or to access the object from a different thread. - can be called from any thread. + can be called from any thread. - The difference between and is returns a Boolean indicating whether the calling thread has access to the and throws an exception. + The difference between and is returns a Boolean indicating whether the calling thread has access to the and throws an exception. ## Examples - The following example uses to determine whether a thread has access to a . The method on the associated with the is called to verify access to the thread. If the calling thread has access to the , the is updated by accessing the members of the ; otherwise, a delegate, which accepts a as an argument, is placed onto the . The will delegate the work of updating the . + The following example uses to determine whether a thread has access to a . The method on the associated with the is called to verify access to the thread. If the calling thread has access to the , the is updated by accessing the members of the ; otherwise, a delegate, which accepts a as an argument, is placed onto the . The will delegate the work of updating the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/CheckAccess/Window1.xaml.cs" id="Snippetdispatcheraccesscheckaccess"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/CheckAccess/window1.xaml.vb" id="Snippetdispatcheraccesscheckaccess"::: @@ -657,7 +657,7 @@ is not associated with the current thread, a new will be created. This is not the case with the method. will return `null` if there is not a dispatcher associated with the specified thread. + If a is not associated with the current thread, a new will be created. This is not the case with the method. will return `null` if there is not a dispatcher associated with the specified thread. ]]> @@ -704,12 +704,12 @@ - Message processing is not permitted. - The structure that returns when it is called can be used to re-enable dispatcher processing. Calling on the structure re-enables processing. + The structure that returns when it is called can be used to re-enable dispatcher processing. Calling on the structure re-enables processing. - can only be called on the thread the is associated with. + can only be called on the thread the is associated with. ## Examples - The following example shows how to disable dispatcher processing and re-enable dispatcher processing. is called in a **using** statement. returns a structure that is used as the object to be disposed when the **using** block finishes. When is called on the structure, dispatcher processing is re-enabled. + The following example shows how to disable dispatcher processing and re-enable dispatcher processing. is called in a **using** statement. returns a structure that is used as the object to be disposed when the **using** block finishes. When is called on the structure, dispatcher processing is re-enabled. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/DisableProcessing/Window1.xaml.cs" id="Snippetdispatcherdisableprocessing"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/DisableProcessing/window1.xaml.vb" id="Snippetdispatcherdisableprocessing"::: @@ -791,7 +791,7 @@ ## Remarks If a dispatcher is not available for the specified thread, `null` will be returned. - does not create a on a thread that does not have a . A new is created on a thread that does not already have a when attempting to get the by using the property. + does not create a on a thread that does not have a . A new is created on a thread that does not already have a when attempting to get the by using the property. ]]> @@ -834,7 +834,7 @@ starts to shut down, the event is raised and is set to `true`. + When the starts to shut down, the event is raised and is set to `true`. The does not shutdown completely until the event queue unwinds. @@ -883,7 +883,7 @@ starts to shut down, the event is raised and is set to `true`. + When the starts to shut down, the event is raised and is set to `true`. The does not shut down completely until the event queue unwinds. @@ -952,12 +952,12 @@ may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ## Examples - The following example places a delegate onto a at using . + The following example places a delegate onto a at using . :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Invoke/Window1.xaml.cs" id="Snippetsystemtimerdispatcherinvoke"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Invoke/window1.xaml.vb" id="Snippetsystemtimerdispatcherinvoke"::: @@ -1081,9 +1081,9 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1135,12 +1135,12 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ## Examples - The following example places a delegate onto a at using . + The following example places a delegate onto a at using . :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/Invoke/Window1.xaml.cs" id="Snippetsystemtimerdispatcherinvoke"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/Invoke/window1.xaml.vb" id="Snippetsystemtimerdispatcherinvoke"::: @@ -1242,9 +1242,9 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control won't return to the calling object until after the callback returns. + is a synchronous operation; therefore, control won't return to the calling object until after the callback returns. ]]> @@ -1299,9 +1299,9 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1357,9 +1357,9 @@ The default priority is `DispatcherPriority.Send`. ## Remarks `arg` can be `null` if an argument is not needed - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1423,9 +1423,9 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1542,9 +1542,9 @@ The default priority is `DispatcherPriority.Send`. may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1617,9 +1617,9 @@ The default priority is `DispatcherPriority.Send`. ## Remarks `arg` can be `null` if an argument is not needed - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1687,9 +1687,9 @@ The default priority is `DispatcherPriority.Send`. ## Remarks `arg` can be `null` if an argument is not needed - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -1762,9 +1762,9 @@ The default priority is `DispatcherPriority.Send`. ## Remarks `arg` can be `null` if an argument is not needed. - In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . + In WPF, only the thread that created a may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a that was created on the UI thread. In order for the background thread to access the Content property of the , the background thread must delegate the work to the associated with the UI thread. This is accomplished by using either or . is synchronous and is asynchronous. The operation is added to the event queue of the at the specified . - is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. + is a synchronous operation; therefore, control will not return to the calling object until after the callback returns. ]]> @@ -2233,9 +2233,9 @@ This method stores in the task it returns all non-usage exceptions that the meth demands unrestricted UI Permissions. + demands unrestricted UI Permissions. - When the starts to shut down, the event is raised and is set to `true`. + When the starts to shut down, the event is raised and is set to `true`. The does not shut down completely until the event queue unwinds. @@ -2288,14 +2288,14 @@ This method stores in the task it returns all non-usage exceptions that the meth ## Remarks A represents a loop that processes pending work items. - The Dispatcher processes the work item queue in a loop. The loop is referred to as a frame. The initial loop is typically initiated by the application by calling . + The Dispatcher processes the work item queue in a loop. The loop is referred to as a frame. The initial loop is typically initiated by the application by calling . - enters a loop represented by the parameter `frame`. At each iteration of the loop, the will check the property on the class to determine whether the loop should continue or if it should stop. + enters a loop represented by the parameter `frame`. At each iteration of the loop, the will check the property on the class to determine whether the loop should continue or if it should stop. allows for the property to be set explicitly and it respects the property on the . This means when the starts to shut down, frames that use the default implementation will exit, which enables all nested frames to exit. ## Examples - The following example shows how to use a to achieve similar results as the Windows Forms method. + The following example shows how to use a to achieve similar results as the Windows Forms method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/DisableProcessing/Window1.xaml.cs" id="Snippetdispatcherdispatcherframedoevents"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/DisableProcessing/window1.xaml.vb" id="Snippetdispatcherdispatcherframedoevents"::: @@ -2353,7 +2353,7 @@ This method stores in the task it returns all non-usage exceptions that the meth processes the event queue in a loop. The loop is referred to as a frame. The initial loop is typically initiated by the application by calling . + The processes the event queue in a loop. The loop is referred to as a frame. The initial loop is typically initiated by the application by calling . The main execution frame will continue until the is shutdown. @@ -2391,7 +2391,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is started, the event is raised and is set to `true`. + When the shutdown process of a is started, the event is raised and is set to `true`. The does not shutdown completely until the event queue unwinds. @@ -2437,7 +2437,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is started, the event is raised and is set to `true`. + When the shutdown process of a is started, the event is raised and is set to `true`. The does not shutdown completely until the event queue unwinds. @@ -2518,13 +2518,13 @@ This method stores in the task it returns all non-usage exceptions that the meth or is uncaught. + This event is raised when an exception that was thrown during execution of a delegate by way of or is uncaught. A handler can mark the exception as handled, which will prevent the internal exception handler from being called. Event handlers for this event must be written with care to avoid creating secondary exceptions and to catch any that occur. It is recommended to avoid allocating memory or doing any resource intensive operations in the handler. - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. ]]> @@ -2571,13 +2571,13 @@ This method stores in the task it returns all non-usage exceptions that the meth or and is uncaught. + This event is raised during the filter stage for an exception that is raised during execution of a delegate by way of or and is uncaught. The call stack is not unwound at this point (first-chance exception). Event handlers for this event must be written with care to avoid creating secondary exceptions and to catch any that occur. It is recommended to avoid allocating memory or doing any resource intensive operations in the handler. - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. ]]> @@ -2661,10 +2661,10 @@ This method stores in the task it returns all non-usage exceptions that the meth This method is public; therefore, any thread can check to see whether it has access to the . - The difference between and is returns a Boolean if the calling thread does not have access to the and throws an exception. + The difference between and is returns a Boolean if the calling thread does not have access to the and throws an exception. ## Examples - The following example uses to determine whether a thread has access to the thread that a was created on. The method takes an object as an argument, which is cast to a . The method on the of the is called to verify access to the thread. + The following example uses to determine whether a thread has access to the thread that a was created on. The method takes an object as an argument, which is cast to a . The method on the of the is called to verify access to the thread. If the calling thread has access to the , the is updated by just accessing the members of the . @@ -2720,7 +2720,7 @@ This method stores in the task it returns all non-usage exceptions that the meth ## Remarks This method provides a way for you to temporarily release execution control to the current dispatcher so it can do other work, such as process other events. Use the `await`, or `Await` in Visual Basic, operator on the return value to return control to the current dispatcher. Use this method if want to give your app a chance to process events while you app is doing a lot of work on the UI thread. For example, you can use this method in a long-running loop that updates a control. - This method is equivalent to calling the method and passing in . + This method is equivalent to calling the method and passing in . ]]> diff --git a/xml/System.Windows.Threading/DispatcherFrame.xml b/xml/System.Windows.Threading/DispatcherFrame.xml index c116ab3e640..29e20a05611 100644 --- a/xml/System.Windows.Threading/DispatcherFrame.xml +++ b/xml/System.Windows.Threading/DispatcherFrame.xml @@ -41,7 +41,7 @@ ## Examples - The following example shows how to use a to achieve similar results as the Windows Forms method. + The following example shows how to use a to achieve similar results as the Windows Forms method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/DisableProcessing/Window1.xaml.cs" id="Snippetdispatcherdispatcherframedoevents"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/DisableProcessing/window1.xaml.vb" id="Snippetdispatcherdispatcherframedoevents"::: @@ -173,7 +173,7 @@ At application shutdown, all frames are requested to exit. is queried at the top of each dispatcher loop. + is queried at the top of each dispatcher loop. At application shutdown, all frames are request to exit. @@ -184,7 +184,7 @@ At application shutdown, all frames are requested to exit. ## Examples - The following example shows how to use a to achieve similar results as the Windows Forms method. + The following example shows how to use a to achieve similar results as the Windows Forms method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/DisableProcessing/Window1.xaml.cs" id="Snippetdispatcherdispatcherframedoevents"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/DisableProcessing/window1.xaml.vb" id="Snippetdispatcherdispatcherframedoevents"::: diff --git a/xml/System.Windows.Threading/DispatcherHooks.xml b/xml/System.Windows.Threading/DispatcherHooks.xml index fb7cd6a4b10..3384efb7ee9 100644 --- a/xml/System.Windows.Threading/DispatcherHooks.xml +++ b/xml/System.Windows.Threading/DispatcherHooks.xml @@ -62,11 +62,11 @@ Occurs when the dispatcher has no more operations to process. - @@ -109,11 +109,11 @@ Occurs when an operation is aborted. - @@ -156,11 +156,11 @@ Occurs when an operation completes. - @@ -203,15 +203,15 @@ Occurs when an operation is posted to the dispatcher. - . - - This event can occur during a call to if any priority other than is specified, or if the destination dispatcher is owned by a different thread. - - Any thread can post operations; therefore, this event can be raised by any thread. - + . + + This event can occur during a call to if any priority other than is specified, or if the destination dispatcher is owned by a different thread. + + Any thread can post operations; therefore, this event can be raised by any thread. + ]]> @@ -254,11 +254,11 @@ Occurs when the priority of an operation is changed. - @@ -300,16 +300,16 @@ Occurs when an operation is invoked. - diff --git a/xml/System.Windows.Threading/DispatcherObject.xml b/xml/System.Windows.Threading/DispatcherObject.xml index b7e3df1a200..a895b138bbb 100644 --- a/xml/System.Windows.Threading/DispatcherObject.xml +++ b/xml/System.Windows.Threading/DispatcherObject.xml @@ -24,23 +24,23 @@ Represents an object that is associated with a . - was created on may access the directly. To access a from a thread other than the thread the was created on, call or on the the is associated with. - - Subclasses of that need to enforce thread safety can do so by calling on all public methods. This guarantees the calling thread is the thread that the was created on. - - A cannot be independently instantiated; that is, all constructors are protected. - - Objects that derive from have thread affinity. - - Objects that derive from are free-threaded when they are frozen. For more information, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). - + was created on may access the directly. To access a from a thread other than the thread the was created on, call or on the the is associated with. + + Subclasses of that need to enforce thread safety can do so by calling on all public methods. This guarantees the calling thread is the thread that the was created on. + + A cannot be independently instantiated; that is, all constructors are protected. + + Objects that derive from have thread affinity. + + Objects that derive from are free-threaded when they are frozen. For more information, see the [Freezable Objects Overview](/dotnet/framework/wpf/advanced/freezable-objects-overview). + ]]> - Any public members of this type are thread safe. Any instance members are not guaranteed to be thread safe. - + Any public members of this type are thread safe. Any instance members are not guaranteed to be thread safe. + This object can be accessed only from the thread on which it was created. Attempts to access it from other threads will throw an . or provide support for marshaling work to the correct thread. @@ -104,25 +104,25 @@ if the calling thread has access to this object; otherwise, . - was created on may access the . - - Any thread can check to see whether it has access to this . - - The difference between and is that returns a Boolean that specifies whether the calling thread has access to this and throws an exception if the calling thread does not have access to the this . - - Calling this method is identical to calling on the associated object. - - - -## Examples - The following example uses to determine whether a thread has access to the thread that a was created on. The method on the is called to verify access to the thread. If the calling thread has access, the is updated by just accessing the members of the ; otherwise, a delegate, which accepts a as an argument, is posted onto the of the . - + was created on may access the . + + Any thread can check to see whether it has access to this . + + The difference between and is that returns a Boolean that specifies whether the calling thread has access to this and throws an exception if the calling thread does not have access to the this . + + Calling this method is identical to calling on the associated object. + + + +## Examples + The following example uses to determine whether a thread has access to the thread that a was created on. The method on the is called to verify access to the thread. If the calling thread has access, the is updated by just accessing the members of the ; otherwise, a delegate, which accepts a as an argument, is posted onto the of the . + :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/DispatcherObject/CheckAccess/Window1.xaml.cs" id="Snippetdispatcherobjectaccesscheckaccess"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/DispatcherObject/CheckAccess/window1.xaml.vb" id="Snippetdispatcherobjectaccesscheckaccess"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/DispatcherObject/CheckAccess/window1.xaml.vb" id="Snippetdispatcherobjectaccesscheckaccess"::: + ]]> @@ -164,11 +164,11 @@ Gets the this is associated with. The dispatcher. - was created on may access the directly. To access a from a thread other than the thread the was created on, call and on the the is associated with. - + was created on may access the directly. To access a from a thread other than the thread the was created on, call and on the the is associated with. + ]]> @@ -206,23 +206,23 @@ Enforces that the calling thread has access to this . - was created on may access the . - - Any thread can check to see whether it has access to this . - - The difference between and is that returns a Boolean that specifies whether the calling thread has access to this and throws an exception if the calling thread does not have access to the this . - - - -## Examples - The following example uses to determine whether a thread has access to the thread that a was created on. If the calling thread does not have access, an is thrown. - + was created on may access the . + + Any thread can check to see whether it has access to this . + + The difference between and is that returns a Boolean that specifies whether the calling thread has access to this and throws an exception if the calling thread does not have access to the this . + + + +## Examples + The following example uses to determine whether a thread has access to the thread that a was created on. If the calling thread does not have access, an is thrown. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/DispatcherObject/CheckAccess/Window1.xaml.cs" id="Snippetdispatcherobjectaccessverifyaccess"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/DispatcherObject/CheckAccess/window1.xaml.vb" id="Snippetdispatcherobjectaccessverifyaccess"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/DispatcherObject/CheckAccess/window1.xaml.vb" id="Snippetdispatcherobjectaccessverifyaccess"::: + ]]> the calling thread does not have access to this . diff --git a/xml/System.Windows.Threading/DispatcherOperation.xml b/xml/System.Windows.Threading/DispatcherOperation.xml index 7506d3f0b4d..bb3056e8954 100644 --- a/xml/System.Windows.Threading/DispatcherOperation.xml +++ b/xml/System.Windows.Threading/DispatcherOperation.xml @@ -32,7 +32,7 @@ returns a object when it is called. + returns a object when it is called. The object can be used to interact with the delegate on the queue, such as changing the priority of the operation or aborting the operation. @@ -78,7 +78,7 @@ ## Remarks If an operation is already in progress, this method will return `false`. - When an operation is aborted, the of the is set to and the event is raised. + When an operation is aborted, the of the is set to and the event is raised. ]]> diff --git a/xml/System.Windows.Threading/DispatcherOperationStatus.xml b/xml/System.Windows.Threading/DispatcherOperationStatus.xml index a3c7378148c..a7881fe5b8d 100644 --- a/xml/System.Windows.Threading/DispatcherOperationStatus.xml +++ b/xml/System.Windows.Threading/DispatcherOperationStatus.xml @@ -23,13 +23,13 @@ Describes the possible values for the status of a . - is returned after a call to . The can be used to interact with the delegate on the queue, such as changing the priority of the operation or aborting the operation. - - The stages of a are Pending, Executing, and Completed. At any point before the operation completes, the status can be set to Aborted. - + is returned after a call to . The can be used to interact with the delegate on the queue, such as changing the priority of the operation or aborting the operation. + + The stages of a are Pending, Executing, and Completed. At any point before the operation completes, the status can be set to Aborted. + ]]> diff --git a/xml/System.Windows.Threading/DispatcherPriority.xml b/xml/System.Windows.Threading/DispatcherPriority.xml index 672234ae2ec..cda3e528981 100644 --- a/xml/System.Windows.Threading/DispatcherPriority.xml +++ b/xml/System.Windows.Threading/DispatcherPriority.xml @@ -23,21 +23,21 @@ Describes the priorities at which operations can be invoked by way of the . - does not throttle the execution of an operation if it exceeds a certain percentage of the CPU. One way to throttle a process is to use a timer. - - If an operation is posted using on its own at a priority of `Send`, the operation bypasses the queue and is immediately executed. - -## Examples - The following example calls the method and passes it a delegate with one argument. The priority is set to `Normal`. - + does not throttle the execution of an operation if it exceeds a certain percentage of the CPU. One way to throttle a process is to use a timer. + + If an operation is posted using on its own at a priority of `Send`, the operation bypasses the queue and is immediately executed. + +## Examples + The following example calls the method and passes it a delegate with one argument. The priority is set to `Normal`. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/BeginInvoke/Window1.xaml.cs" id="Snippetthreadingweatherdispatcheronearge"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/BeginInvoke/window1.xaml.vb" id="Snippetthreadingweatherdispatcheronearge"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/BeginInvoke/window1.xaml.vb" id="Snippetthreadingweatherdispatcheronearge"::: + ]]> diff --git a/xml/System.Windows.Threading/DispatcherPriorityAwaitable.xml b/xml/System.Windows.Threading/DispatcherPriorityAwaitable.xml index 8b9c24444ad..cba70a7aa89 100644 --- a/xml/System.Windows.Threading/DispatcherPriorityAwaitable.xml +++ b/xml/System.Windows.Threading/DispatcherPriorityAwaitable.xml @@ -23,11 +23,11 @@ Represents an awaitable object that asynchronously yields control back to the current dispatcher and provides an opportunity for the dispatcher to process other events. - method returns a . - + method returns a . + ]]> diff --git a/xml/System.Windows.Threading/DispatcherProcessingDisabled.xml b/xml/System.Windows.Threading/DispatcherProcessingDisabled.xml index 11d74a58611..17e2c4c1ff5 100644 --- a/xml/System.Windows.Threading/DispatcherProcessingDisabled.xml +++ b/xml/System.Windows.Threading/DispatcherProcessingDisabled.xml @@ -31,7 +31,7 @@ returns a object when it is called. + returns a object when it is called. Disabling dispatcher processing is an advanced method that is intended to eliminate the chance of unrelated reentrancy. @@ -43,12 +43,12 @@ - Message processing is not permitted. - Calling on the object will re-enable dispatcher processing. + Calling on the object will re-enable dispatcher processing. ## Examples - The following example shows how to disable dispatcher processing and re-enable dispatcher processing. is called in a **using** statement. returns a structure which is used as the object to be disposed when the **using** block finishes. Calling on the structure re-enables dispatcher processing. + The following example shows how to disable dispatcher processing and re-enable dispatcher processing. is called in a **using** statement. returns a structure which is used as the object to be disposed when the **using** block finishes. Calling on the structure re-enables dispatcher processing. :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/DisableProcessing/Window1.xaml.cs" id="Snippetdispatcherdisableprocessing"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Threading/Dispatcher/DisableProcessing/window1.xaml.vb" id="Snippetdispatcherdisableprocessing"::: diff --git a/xml/System.Windows.Threading/DispatcherSynchronizationContext.xml b/xml/System.Windows.Threading/DispatcherSynchronizationContext.xml index 1dd305c1275..08e9590235c 100644 --- a/xml/System.Windows.Threading/DispatcherSynchronizationContext.xml +++ b/xml/System.Windows.Threading/DispatcherSynchronizationContext.xml @@ -24,11 +24,11 @@ Provides a synchronization context for Windows Presentation Foundation (WPF). - is not specified at the creation of the instance, the current is associated with the . - + is not specified at the creation of the instance, the current is associated with the . + ]]> @@ -190,13 +190,13 @@ The object passed to the delegate. Invokes the callback in the synchronization context asynchronously. - . - - starts an asynchronous request to post a message. - + . + + starts an asynchronous request to post a message. + ]]> @@ -235,11 +235,11 @@ The object passed to the delegate. Invokes the callback in the synchronization context synchronously. - . - + . + ]]> diff --git a/xml/System.Windows.Threading/DispatcherTimer.xml b/xml/System.Windows.Threading/DispatcherTimer.xml index df53422d666..9eb608e0c18 100644 --- a/xml/System.Windows.Threading/DispatcherTimer.xml +++ b/xml/System.Windows.Threading/DispatcherTimer.xml @@ -31,19 +31,19 @@ Timers are not guaranteed to execute exactly when the time interval occurs, but they are guaranteed to not execute before the time interval occurs. This is because operations are placed on the queue like other operations. When the operation executes is dependent on the other jobs in the queue and their priorities. - If a is used in a WPF application, it is worth noting that the runs on a different thread than the user interface (UI) thread. In order to access objects on the user interface (UI) thread, it is necessary to post the operation onto the of the user interface (UI) thread using or . Reasons for using a as opposed to a are that the runs on the same thread as the and a can be set on the . + If a is used in a WPF application, it is worth noting that the runs on a different thread than the user interface (UI) thread. In order to access objects on the user interface (UI) thread, it is necessary to post the operation onto the of the user interface (UI) thread using or . Reasons for using a as opposed to a are that the runs on the same thread as the and a can be set on the . A will keep an object alive whenever the object's methods are bound to the timer. ## Examples - The following example creates a that updates the contents of a and calls the method on the . + The following example creates a that updates the contents of a and calls the method on the . - A object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event of `dispatcherTimer`. The is set to 1 second using a object, and the timer is started. + A object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event of `dispatcherTimer`. The is set to 1 second using a object, and the timer is started. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimerinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimerinit"::: - The event handler updates a that displays the current second, and it calls on the . + The event handler updates a that displays the current second, and it calls on the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimer"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimer"::: @@ -93,7 +93,7 @@ runs on the of the current thread at priority. To specify a different , use the following constructor: . + runs on the of the current thread at priority. To specify a different , use the following constructor: . ]]> @@ -129,7 +129,7 @@ runs on the of the current thread. To specify a different , use the following constructor: . + runs on the of the current thread. To specify a different , use the following constructor: . ]]> @@ -292,7 +292,7 @@ Timers are not guaranteed to execute exactly when the time interval occurs, but they are guaranteed to not execute before the time interval occurs. This is because operations are placed on the queue like other operations. When the operation executes is dependent on the other jobs in the queue and their priorities. ## Examples - The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. + The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimerinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimerinit"::: @@ -340,14 +340,14 @@ must be set to `true` for the event to be raised. + must be set to `true` for the event to be raised. - Calling sets to `true`. + Calling sets to `true`. - Calling sets to `false`. + Calling sets to `false`. ## Examples - The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. + The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimerinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimerinit"::: @@ -386,18 +386,18 @@ to `false` when the timer is started stops the timer. + Setting to `false` when the timer is started stops the timer. - Setting to `true` when the timer is stopped starts the timer. + Setting to `true` when the timer is stopped starts the timer. - sets to `true`. + sets to `true`. - resets the timer . + resets the timer . ## Examples - The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. + The following example creates a . A new object named `dispatcherTimer` is created. The event handler `dispatcherTimer_Tick` is added to the event. The is set to 1 second using a object. :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimerinit"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimerinit"::: @@ -436,11 +436,11 @@ to `false` when the timer is started stops the timer. + Setting to `false` when the timer is started stops the timer. - Setting to `true` when the timer is stopped starts the timer. + Setting to `true` when the timer is stopped starts the timer. - Calling sets to `false`. + Calling sets to `false`. ]]> @@ -515,7 +515,7 @@ event handler. The event handler updates a that displays the current second, and it calls on the . + The following example creates a event handler. The event handler updates a that displays the current second, and it calls on the . :::code language="csharp" source="~/snippets/csharp/System.Windows.Input/CanExecuteRoutedEventArgs/Parameter/Window1.xaml.cs" id="Snippetinvalidatesampledispatchertimer"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Input/CommandManager/InvalidateRequerySuggested/window1.xaml.vb" id="Snippetinvalidatesampledispatchertimer"::: diff --git a/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventArgs.xml b/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventArgs.xml index d4288003667..962d8708cd4 100644 --- a/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventArgs.xml +++ b/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventArgs.xml @@ -24,13 +24,13 @@ Provides data for the event. - event occurs when code executing by way of the throws an exception which is not handled. - - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. - + event occurs when code executing by way of the throws an exception which is not handled. + + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + ]]> diff --git a/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventHandler.xml b/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventHandler.xml index 105b71b75a5..dca78126638 100644 --- a/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventHandler.xml +++ b/xml/System.Windows.Threading/DispatcherUnhandledExceptionEventHandler.xml @@ -32,13 +32,13 @@ The event data. Represents the method that will handle the event. - event occurs when code executing by way of the throws an exception which is not handled. - - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. - + event occurs when code executing by way of the throws an exception which is not handled. + + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + ]]> diff --git a/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventArgs.xml b/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventArgs.xml index bc11bda5503..09a15c275a4 100644 --- a/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventArgs.xml +++ b/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventArgs.xml @@ -24,13 +24,13 @@ Provides data for the event. - event occurs when code executing by way of the throws an exception which is not handled. - - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. - + event occurs when code executing by way of the throws an exception which is not handled. + + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + ]]> @@ -109,13 +109,13 @@ if the should be raised; otherwise; . The default value is . - event provides a means to not raise the event. The is raised first, and If on the is set to `false`, the event will not be raised. - - A previous handler in the event multicast might have already set this property to `false`, indicating that the exception will not be caught. The "don't catch" behavior will override all others because it most likely means a debugging scenario. - + event provides a means to not raise the event. The is raised first, and If on the is set to `false`, the event will not be raised. + + A previous handler in the event multicast might have already set this property to `false`, indicating that the exception will not be caught. The "don't catch" behavior will override all others because it most likely means a debugging scenario. + ]]> diff --git a/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventHandler.xml b/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventHandler.xml index abc38b078a7..966242ebc12 100644 --- a/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventHandler.xml +++ b/xml/System.Windows.Threading/DispatcherUnhandledExceptionFilterEventHandler.xml @@ -32,13 +32,13 @@ The event data. Represents the method that will handle the event. - event occurs when code executing by way of the throws an exception that is not handled. - - The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. - + event occurs when code executing by way of the throws an exception that is not handled. + + The event provides a means to not raise the event. The event is raised first, and If on the is set to `false`, the event will not be raised. + ]]> diff --git a/xml/System.Windows.Threading/TaskExtensions.xml b/xml/System.Windows.Threading/TaskExtensions.xml index b1ccc0847f6..449db2daf21 100644 --- a/xml/System.Windows.Threading/TaskExtensions.xml +++ b/xml/System.Windows.Threading/TaskExtensions.xml @@ -23,11 +23,11 @@ Provides a set of methods that extend the class. - class. This means that they can be called like an instance method on any object. The methods in this class operate on objects that are associated with a object. - + class. This means that they can be called like an instance method on any object. The methods in this class operate on objects that are associated with a object. + ]]> @@ -71,11 +71,11 @@ Waits indefinitely for the underlying to complete. The status of the underlying . - method to check whether the is associated with a before you call this method. - + method to check whether the is associated with a before you call this method. + ]]> The is not associated with a . @@ -113,11 +113,11 @@ Waits for the specified amount of time for the underlying to complete. The status of the underlying . - method to check whether the is associated with a before you call this method. - + method to check whether the is associated with a before you call this method. + ]]> The is not associated with a . @@ -153,11 +153,11 @@ Returns a value that indicates whether this is associated with a . The status of the underlying . - is associated with a ; otherwise, `false`. - + is associated with a ; otherwise, `false`. + ]]> diff --git a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceReader.xml b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceReader.xml index 6b7ec0bcb79..b4662852644 100644 --- a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceReader.xml +++ b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceReader.xml @@ -30,7 +30,7 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDialog.xaml.cs" id="Snippetsignaturedefinitioncommandhandler"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedialog.xaml.vb" id="Snippetsignaturedefinitioncommandhandler"::: - The following example shows how to obtain a in order to access parts in an . + The following example shows how to obtain a in order to access parts in an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Window1.xaml.cs" id="Snippetdocstrucfixeddoc"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/window1.xaml.vb" id="Snippetdocstrucfixeddoc"::: diff --git a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceWriter.xml b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceWriter.xml index 5cdc5816a24..b979fe2558c 100644 --- a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceWriter.xml +++ b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentSequenceWriter.xml @@ -25,7 +25,7 @@ method in order to obtain a writer for adding content to an . + The following example shows how to use the method in order to obtain a writer for adding content to an . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -66,7 +66,7 @@ method. + The following example shows how to use the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -150,7 +150,7 @@ method to flush and close the writer. + The following example shows how to use the method to flush and close the writer. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -190,7 +190,7 @@ for a particular . If needed, use the method to create a -specific that is valid for a specified printer. + Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a specified printer. diff --git a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentWriter.xml b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentWriter.xml index 0e6afae14f4..16c503bdc38 100644 --- a/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentWriter.xml +++ b/xml/System.Windows.Xps.Packaging/IXpsFixedDocumentWriter.xml @@ -29,7 +29,7 @@ method in order to obtain a fixed-document writer for adding content to an . + The following example shows how to use the method in order to obtain a fixed-document writer for adding content to an . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -70,7 +70,7 @@ method. + The following example shows how to use the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateadddoccontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateadddoccontent"::: @@ -153,7 +153,7 @@ method to flush and close the writer. + The following example shows how to use the method to flush and close the writer. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -193,7 +193,7 @@ property is zero-based. A value of zero (0) indicates the first the in the . + The property is zero-based. A value of zero (0) indicates the first the in the . ]]> @@ -229,7 +229,7 @@ for a particular . If needed, use the method to create a -specific that is valid for a given printer. + Setting this property does not validate or modify the specified for a particular . If needed, use the method to create a -specific that is valid for a given printer. diff --git a/xml/System.Windows.Xps.Packaging/IXpsFixedPageWriter.xml b/xml/System.Windows.Xps.Packaging/IXpsFixedPageWriter.xml index c1ab77cf678..bc3d5af28c0 100644 --- a/xml/System.Windows.Xps.Packaging/IXpsFixedPageWriter.xml +++ b/xml/System.Windows.Xps.Packaging/IXpsFixedPageWriter.xml @@ -29,7 +29,7 @@ method to obtain a fixed-page writer for adding pages to an . + The following example shows how to use the method to obtain a fixed-page writer for adding pages to an . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateadddoccontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateadddoccontent"::: @@ -75,7 +75,7 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . ]]> @@ -99,7 +99,7 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . ]]> @@ -141,12 +141,12 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . ## Examples - The following example shows how to use the method to add a font resource to a page. + The following example shows how to use the method to add a font resource to a page. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: @@ -198,14 +198,14 @@ adds a new with optional obfuscation to the document package and associates it with the current . + adds a new with optional obfuscation to the document package and associates it with the current . Set the `obfuscate` parameter to `true` when you are legally obligated to obfuscate a licensed proprietary font. While obfuscation does not encrypt the font, it inhibits unzipping proprietary fonts and installing them separately for other uses. For more information about font obfuscation, see Section 2.1.7.3 "Embedded Font Obfuscation" in the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). ## Examples - The following example shows how to use the method in order to add a font resource to a page. + The following example shows how to use the method in order to add a font resource to a page. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: @@ -256,14 +256,14 @@ adds a new with optional obfuscation or restrictions to the document package, and associates it with the current . + adds a new with optional obfuscation or restrictions to the document package, and associates it with the current . Set the `obfuscate` parameter to `true` when you are legally obligated to obfuscate a licensed proprietary font. While obfuscation does not encrypt the font, it inhibits unzipping proprietary fonts and installing them separately for other uses. For more information about font obfuscation and the use of restricted fonts, see the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). ## Examples - The following example shows how to use the method to add a font resource to a page. + The following example shows how to use the method to add a font resource to a page. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: @@ -288,7 +288,7 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . ]]> @@ -334,12 +334,12 @@ adds a new with a specified `mimeType` to the document package and associates it with the current . + adds a new with a specified `mimeType` to the document package and associates it with the current . ## Examples - The following example shows how to use the method to add an image resource to a page. + The following example shows how to use the method to add an image resource to a page. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: @@ -390,14 +390,14 @@ adds a new with the specified to the document package and associates it with the current . + adds a new with the specified to the document package and associates it with the current . For example, `imageType` can be or . to add a JPEG or PNG , respectively. ## Examples - The following example shows how to use the method to add an image resource to a page. + The following example shows how to use the method to add an image resource to a page. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: @@ -446,9 +446,9 @@ adds a new to the document package, and associates it with the current . + adds a new to the document package, and associates it with the current . - If `resourceUri` is `null`, a unique resource is automatically created. + If `resourceUri` is `null`, a unique resource is automatically created. ]]> @@ -492,7 +492,7 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . ]]> @@ -535,7 +535,7 @@ adds a new to the document package and associates it with the current . + adds a new to the document package and associates it with the current . For example, `imageType` can be or . to add a JPEG or PNG thumbnail image, respectively. @@ -580,12 +580,12 @@ and , such as and , the flush operation of the method may be delayed until the complete is closed. + Based on settings of and , such as and , the flush operation of the method may be delayed until the complete is closed. ## Examples - The following example shows how to flush and close the fixed-page writer with the method. + The following example shows how to flush and close the fixed-page writer with the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateadddoccontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateadddoccontent"::: @@ -625,7 +625,7 @@ hyperlink points is available after the page has been written and the method has been called. + The list of hyperlink points is available after the page has been written and the method has been called. For information about elements, see Section 3.2.3 "\ Element" in the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). @@ -663,7 +663,7 @@ property returns the zero-based page number for this of the document. ( value of zero is the first page.) + The property returns the zero-based page number for this of the document. ( value of zero is the first page.) ]]> @@ -757,7 +757,7 @@ method to obtain an . + The following example shows how to use the method to obtain an . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateadddoccontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateadddoccontent"::: diff --git a/xml/System.Windows.Xps.Packaging/PackagingProgressEventArgs.xml b/xml/System.Windows.Xps.Packaging/PackagingProgressEventArgs.xml index 8f3b55636ae..8544ddc4e4f 100644 --- a/xml/System.Windows.Xps.Packaging/PackagingProgressEventArgs.xml +++ b/xml/System.Windows.Xps.Packaging/PackagingProgressEventArgs.xml @@ -61,48 +61,48 @@ The number of simultaneous times that the specified occurred. Initializes a new instance of the class. - and `numberCompleted` is more than 1. For example, when you print, font subsetting is performed every four pages. Each page must be cached until the subsetting is complete, and then all four events occur at the same time. The constructor for the resulting sets `action` to and sets `numberCompleted` to 4. - - For example, if a package consists of a single four-page document that uses one font and no images or other resources, the sequence of events might occur as shown in the following table. - - **The sequence of events for a simple package** - - AddingDocumentSequence - 1 - - AddingFixedDocument - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - FontAdded - 1 - - FixedPageCompleted - 4 - - FixedDocumentCompleted - 1 - - DocumentSequenceCompleted - 1 - - XpsDocumentCommitted - 1 - + and `numberCompleted` is more than 1. For example, when you print, font subsetting is performed every four pages. Each page must be cached until the subsetting is complete, and then all four events occur at the same time. The constructor for the resulting sets `action` to and sets `numberCompleted` to 4. + + For example, if a package consists of a single four-page document that uses one font and no images or other resources, the sequence of events might occur as shown in the following table. + + **The sequence of events for a simple package** + + AddingDocumentSequence + 1 + + AddingFixedDocument + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + FontAdded + 1 + + FixedPageCompleted + 4 + + FixedDocumentCompleted + 1 + + DocumentSequenceCompleted + 1 + + XpsDocumentCommitted + 1 + ]]> @@ -175,48 +175,48 @@ Gets the number of simultaneous times that the action that is identified in has occurred. An that represents the number of simultaneous times that the action that is identified in has occurred. - and is more than 1. For example, when you print, font subsetting is performed every four pages. Each page must be cached until the subsetting is complete, and then all four events occur at the same time. The resulting sets to and sets to 4. - - For example, if a package consists of a single four-page document that uses one font and no images or other resources, the sequence of events might occur as shown in the following table: - - **The sequence of events for a simple package** - - AddingDocumentSequence - 1 - - AddingFixedDocument - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - AddingFixedPage - 1 - - FontAdded - 1 - - FixedPageCompleted - 4 - - FixedDocumentCompleted - 1 - - DocumentSequenceCompleted - 1 - - XpsDocumentCommitted - 1 - + and is more than 1. For example, when you print, font subsetting is performed every four pages. Each page must be cached until the subsetting is complete, and then all four events occur at the same time. The resulting sets to and sets to 4. + + For example, if a package consists of a single four-page document that uses one font and no images or other resources, the sequence of events might occur as shown in the following table: + + **The sequence of events for a simple package** + + AddingDocumentSequence + 1 + + AddingFixedDocument + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + AddingFixedPage + 1 + + FontAdded + 1 + + FixedPageCompleted + 4 + + FixedDocumentCompleted + 1 + + DocumentSequenceCompleted + 1 + + XpsDocumentCommitted + 1 + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsColorContext.xml b/xml/System.Windows.Xps.Packaging/XpsColorContext.xml index a001056cf32..410362fa926 100644 --- a/xml/System.Windows.Xps.Packaging/XpsColorContext.xml +++ b/xml/System.Windows.Xps.Packaging/XpsColorContext.xml @@ -24,11 +24,11 @@ Represents the color context for a bitmap image. - method to get a reference to an object of the class. - + method to get a reference to an object of the class. + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsDigSigPartAlteringRestrictions.xml b/xml/System.Windows.Xps.Packaging/XpsDigSigPartAlteringRestrictions.xml index 4010ae0b1f4..3686b477a43 100644 --- a/xml/System.Windows.Xps.Packaging/XpsDigSigPartAlteringRestrictions.xml +++ b/xml/System.Windows.Xps.Packaging/XpsDigSigPartAlteringRestrictions.xml @@ -29,25 +29,25 @@ Specifies the parts of the XPS that are excluded from the range of a digital signature. - .) If the SignatureOrigin part is not excluded, any additional signatures invalidate the signature of the first signer. - - For more information about digital signatures, see [Digital Signing Framework of the Open Packaging Conventions](/previous-versions/dotnet/articles/aa905326(v=msdn.10)). - - For more information on the Core Properties and Signature Origin parts, see Chapter 3 of the *Open Packaging Conventions* specification available for download at . - - - -## Examples - The following example shows how to use this enumeration to digitally sign an XPS document. - + .) If the SignatureOrigin part is not excluded, any additional signatures invalidate the signature of the first signer. + + For more information about digital signatures, see [Digital Signing Framework of the Open Packaging Conventions](/previous-versions/dotnet/articles/aa905326(v=msdn.10)). + + For more information on the Core Properties and Signature Origin parts, see Chapter 3 of the *Open Packaging Conventions* specification available for download at . + + + +## Examples + The following example shows how to use this enumeration to digitally sign an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsDigitalSignature.xml b/xml/System.Windows.Xps.Packaging/XpsDigitalSignature.xml index b677f3f89b4..c47a7801a6e 100644 --- a/xml/System.Windows.Xps.Packaging/XpsDigitalSignature.xml +++ b/xml/System.Windows.Xps.Packaging/XpsDigitalSignature.xml @@ -178,7 +178,7 @@ method when called with the `embedCertificate` parameter set to `true`. + The X.509 certificate of the signer is embedded by the method when called with the `embedCertificate` parameter set to `true`. For more information on digital signatures and certificates, see Section 3.3 Digital Signatures in the *Open Packaging Conventions* specification available for download at . @@ -220,9 +220,9 @@ method when called with the `restrictions` parameter set to exclude the part. + The signature origin restriction is set by the method when called with the `restrictions` parameter set to exclude the part. - If a document is to be signed by more than one person, the part needs to be excluded from the signature when the document is first signed. (Exclusions are specified in the `restrictions` parameter of the call to .) If the part is not excluded, any additional signatures invalidate the signature of the first signer. + If a document is to be signed by more than one person, the part needs to be excluded from the signature when the document is first signed. (Exclusions are specified in the `restrictions` parameter of the call to .) If the part is not excluded, any additional signatures invalidate the signature of the first signer. For more information on the Core Properties and Signature Origin parts, see Chapter 3 of the *Open Packaging Conventions* specification available for download at . @@ -348,7 +348,7 @@ method when called with the `embedCertificate` parameter set to `true`. + The X.509 certificate of the signer is embedded by the method when called with the `embedCertificate` parameter set to `true`. For more information on digital signatures and certificates, see Section 3.3 Digital Signatures in the *Open Packaging Conventions* specification available for download at . @@ -389,9 +389,9 @@ is based on the system time of the computer where the signing took place. + is based on the system time of the computer where the signing took place. - is not a "secure Time Stamp" and is not from trusted Time Stamp Authority. A secure TimeStamp must be obtained and applied through a trusted Time Stamp Authority. + is not a "secure Time Stamp" and is not from trusted Time Stamp Authority. A secure TimeStamp must be obtained and applied through a trusted Time Stamp Authority. ]]> @@ -439,7 +439,7 @@ method when called with the `embedCertificate` parameter set to `true`. + This overload method verifies the document digital signature against the X.509 certificate embedded by the method when called with the `embedCertificate` parameter set to `true`. ]]> @@ -534,7 +534,7 @@ Some certificate verifications may require Internet connectivity. - The X.509 certificate of the signer is embedded by the method when called with the `embedCertificate` parameter set to `true`. + The X.509 certificate of the signer is embedded by the method when called with the `embedCertificate` parameter set to `true`. ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsDocument.xml b/xml/System.Windows.Xps.Packaging/XpsDocument.xml index a1580ab9ea7..2f5020fdfa0 100644 --- a/xml/System.Windows.Xps.Packaging/XpsDocument.xml +++ b/xml/System.Windows.Xps.Packaging/XpsDocument.xml @@ -33,13 +33,13 @@ ## Remarks An contains a that comprises one or more elements. - The constructor is passed a reference to a for writing, storing, and reading the content elements of the document. + The constructor is passed a reference to a for writing, storing, and reading the content elements of the document. - A new empty XPS is created by using the constructor. + A new empty XPS is created by using the constructor. - An existing XPS is opened by using the method. + An existing XPS is opened by using the method. - A root is added to an empty XPS by calling the method. + A root is added to an empty XPS by calling the method. elements with printer information and control can also be associated with the , or on individual and elements that are stored in the . @@ -363,7 +363,7 @@ ## Examples - The following example shows how to use the method to insert content into an . + The following example shows how to use the method to insert content into an . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpkgcontent"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpkgcontent"::: @@ -445,7 +445,7 @@ ## Remarks If the was opened for write access, data buffers are written to the store and the physical document is closed. - After has been called, no parts of the document can be accessed with this instance. + After has been called, no parts of the document can be accessed with this instance. @@ -527,7 +527,7 @@ method in order to write an . + The following example shows how to use the method in order to write an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserializelinked"::: @@ -617,7 +617,7 @@ ## Examples - The following example shows how to get a in order to access parts in an . + The following example shows how to get a in order to access parts in an . :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents.DocumentStructures/FigureStructure/Overview/Window1.xaml.cs" id="Snippetdocstrucfixeddoc"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/window1.xaml.vb" id="Snippetdocstrucfixeddoc"::: @@ -819,7 +819,7 @@ list identifies what parts are signed and whether the signatures are valid. + The list identifies what parts are signed and whether the signatures are valid. ]]> @@ -836,7 +836,7 @@ method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: @@ -889,7 +889,7 @@ ## Examples - The following example shows how to use the method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: @@ -944,7 +944,7 @@ ## Examples - The following example shows how to use the method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: @@ -1004,7 +1004,7 @@ ## Examples - The following example shows how to use the method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/SignatureDefinitionsAndSigning.cs" id="Snippetsignxpsdocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Xps.Packaging/IXpsFixedDocumentReader/Overview/signaturedefinitionsandsigning.vb" id="Snippetsignxpsdocument"::: diff --git a/xml/System.Windows.Xps.Packaging/XpsFont.xml b/xml/System.Windows.Xps.Packaging/XpsFont.xml index 4b324e87ee0..05f459a0bb4 100644 --- a/xml/System.Windows.Xps.Packaging/XpsFont.xml +++ b/xml/System.Windows.Xps.Packaging/XpsFont.xml @@ -24,26 +24,26 @@ Represents a font in an . - class has no public constructor. - - Use the method to add a font and obtain a reference to it in a new document. - - Use the method to obtain a font reference in an existing document. - - Based on settings of and , such as and , the flush operation of the method of the class may be delayed until the whole is closed. - - - -## Examples - The following example shows how to add fonts to an . - + class has no public constructor. + + Use the method to add a font and obtain a reference to it in a new document. + + Use the method to obtain a font reference in an existing document. + + Based on settings of and , such as and , the flush operation of the method of the class may be delayed until the whole is closed. + + + +## Examples + The following example shows how to add fonts to an . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: + ]]> @@ -84,11 +84,11 @@ if the font is obfuscated; otherwise, . - @@ -132,11 +132,11 @@ if text that uses this font can be changed or edited; otherwise, . - @@ -173,15 +173,15 @@ The globally unique identifier (GUID) to use to obfuscate the . Obfuscates the font typeface data. - method is provided for use when you are legally obligated to obfuscate licensed proprietary fonts. - - While this method does not provide encryption, the method can be used to inhibit users from unzipping proprietary OpenType fonts and installing them separately for other uses. - - For more information about font obfuscation, see Section 2.1.7.3 "Embedded Font Obfuscation" in the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). - + method is provided for use when you are legally obligated to obfuscate licensed proprietary fonts. + + While this method does not provide encryption, the method can be used to inhibit users from unzipping proprietary OpenType fonts and installing them separately for other uses. + + For more information about font obfuscation, see Section 2.1.7.3 "Embedded Font Obfuscation" in the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsImage.xml b/xml/System.Windows.Xps.Packaging/XpsImage.xml index 59c6399d08a..78ba74f0ae6 100644 --- a/xml/System.Windows.Xps.Packaging/XpsImage.xml +++ b/xml/System.Windows.Xps.Packaging/XpsImage.xml @@ -24,26 +24,26 @@ Represents an image in an . - class has no public constructor. - - Use the method to add an image and obtain a reference to it in a new document. - - Use the method to obtain an image reference in an existing document. - - Based on settings of and , such as and , the flush operation of the method of the class may be delayed until the complete is closed. - - - -## Examples - The following example shows how to add images to an . - + class has no public constructor. + + Use the method to add an image and obtain a reference to it in a new document. + + Use the method to obtain an image reference in an existing document. + + Based on settings of and , such as and , the flush operation of the method of the class may be delayed until the complete is closed. + + + +## Examples + The following example shows how to add images to an . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsResource.xml b/xml/System.Windows.Xps.Packaging/XpsResource.xml index 698a5838877..2103192cad9 100644 --- a/xml/System.Windows.Xps.Packaging/XpsResource.xml +++ b/xml/System.Windows.Xps.Packaging/XpsResource.xml @@ -28,15 +28,15 @@ Defines the base class for resources that can be added to an . - derived types to an . - + derived types to an . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: + ]]> @@ -71,20 +71,20 @@ Commits all changes and flushes the resource to the document package. - and , such as and , the flush operation of the method may be delayed until the whole is closed. - - - -## Examples - The following example shows how to use the method (in a derived class) when you add resources to an . - + and , such as and , the flush operation of the method may be delayed until the whole is closed. + + + +## Examples + The following example shows how to use the method (in a derived class) when you add resources to an . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: + ]]> @@ -117,15 +117,15 @@ When overridden in a derived class, returns the I/O stream for reading or writing the resource. The for reading or writing the resource. - . - + . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetxpscreateaddpageresources"::: :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetxpscreateaddpageresources"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetxpscreateaddpageresources"::: + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsResourceDictionary.xml b/xml/System.Windows.Xps.Packaging/XpsResourceDictionary.xml index 7cbe3cdf88e..5735ae3a693 100644 --- a/xml/System.Windows.Xps.Packaging/XpsResourceDictionary.xml +++ b/xml/System.Windows.Xps.Packaging/XpsResourceDictionary.xml @@ -24,13 +24,13 @@ Represents a dictionary of elements that are usable across pages of the . - by using the method. - - For more information about the `ResourceDictionary` element of an XPS package, see chapter 7 in the XML Paper Specification (XPS) specification, which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). - + by using the method. + + For more information about the `ResourceDictionary` element of an XPS package, see chapter 7 in the XML Paper Specification (XPS) specification, which you can obtain at [XPS: Specification and License Downloads](https://www.microsoft.com/download/details.aspx?id=51478). + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsStructure.xml b/xml/System.Windows.Xps.Packaging/XpsStructure.xml index 196e8a5d6ef..2092ddb2361 100644 --- a/xml/System.Windows.Xps.Packaging/XpsStructure.xml +++ b/xml/System.Windows.Xps.Packaging/XpsStructure.xml @@ -24,13 +24,13 @@ Represents the or element of an . - are obtained through the or methods. - - For more information about the or elements of an , see Chapter 9 in the [XPS Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). - + are obtained through the or methods. + + For more information about the or elements of an , see Chapter 9 in the [XPS Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). + ]]> diff --git a/xml/System.Windows.Xps.Packaging/XpsThumbnail.xml b/xml/System.Windows.Xps.Packaging/XpsThumbnail.xml index d6ce9a0df1f..ee2ce4d76b3 100644 --- a/xml/System.Windows.Xps.Packaging/XpsThumbnail.xml +++ b/xml/System.Windows.Xps.Packaging/XpsThumbnail.xml @@ -24,13 +24,13 @@ Represents a thumbnail image of a document sequence, single document, or single page. - class has no public constructor. A reference to an is provided through the , , or methods. - - It is recommended that if any page in an has a thumbnail, that all pages be specified with thumbnails. - + class has no public constructor. A reference to an is provided through the , , or methods. + + It is recommended that if any page in an has a thumbnail, that all pages be specified with thumbnails. + ]]> diff --git a/xml/System.Windows.Xps.Serialization/BasePackagingPolicy.xml b/xml/System.Windows.Xps.Serialization/BasePackagingPolicy.xml index 2f7b1027a57..2900a14d017 100644 --- a/xml/System.Windows.Xps.Serialization/BasePackagingPolicy.xml +++ b/xml/System.Windows.Xps.Serialization/BasePackagingPolicy.xml @@ -272,7 +272,7 @@ element for the corresponding page. Wrap each string in the list in markup by using the following form: + Use the list to compose `LinkTarget` elements that can be inserted into the element for the corresponding page. Wrap each string in the list in markup by using the following form: ``, where *target name* is the string. @@ -524,7 +524,7 @@ . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. ]]> diff --git a/xml/System.Windows.Xps.Serialization/FontTypeConverter.xml b/xml/System.Windows.Xps.Serialization/FontTypeConverter.xml index 0e43268dcfd..e4d5533a342 100644 --- a/xml/System.Windows.Xps.Serialization/FontTypeConverter.xml +++ b/xml/System.Windows.Xps.Serialization/FontTypeConverter.xml @@ -24,11 +24,11 @@ Provides type converters for converting objects to and from objects of other types. - method. See the base classes and for other important usage notes. - + method. See the base classes and for other important usage notes. + ]]> @@ -62,11 +62,11 @@ Initializes a new instance of the class. - method. See the base classes and for other important usage notes. - + method. See the base classes and for other important usage notes. + ]]> @@ -111,13 +111,13 @@ if objects of the specified type can be converted; otherwise, . - . - - The `context` parameter is not used. See Notes for Inheritors. - + . + + The `context` parameter is not used. See Notes for Inheritors. + ]]> @@ -165,13 +165,13 @@ if conversion is possible; otherwise, . - . - - The `context` parameter is not used. See Notes for Inheritors. - + . + + The `context` parameter is not used. See Notes for Inheritors. + ]]> @@ -214,11 +214,11 @@ Converts a specified object to a . The new object. - This method is called from this class instead of from a derived class. @@ -266,15 +266,15 @@ Converts a to an object of the specified type. The new of the designated type. As implemented in this class, this must be a . It expresses the uniform resource identifier (URI) of the font subset that is used by the parameter. - . - - As implemented in this class, `destinationType` must be a or the is thrown. - - The `culture` parameter is not used. See Notes for Inheritors. - + . + + As implemented in this class, `destinationType` must be a or the is thrown. + + The `culture` parameter is not used. See Notes for Inheritors. + ]]> The is not a type that can be converted to. @@ -321,11 +321,11 @@ Gets a collection of property descriptions for the specified type. A that contains the property descriptions that are exposed for the component; or if no property descriptions are returned. - This method is called from this class instead of from a derived class. diff --git a/xml/System.Windows.Xps.Serialization/XpsPackagingPolicy.xml b/xml/System.Windows.Xps.Serialization/XpsPackagingPolicy.xml index ac7e4183495..182b1e6adc5 100644 --- a/xml/System.Windows.Xps.Serialization/XpsPackagingPolicy.xml +++ b/xml/System.Windows.Xps.Serialization/XpsPackagingPolicy.xml @@ -618,11 +618,11 @@ The print ticket to store as part of the XML Paper Specification (XPS) document. Stores a specified as part of the . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> diff --git a/xml/System.Windows.Xps.Serialization/XpsSerializationManager.xml b/xml/System.Windows.Xps.Serialization/XpsSerializationManager.xml index 660837fd915..933cc14209b 100644 --- a/xml/System.Windows.Xps.Serialization/XpsSerializationManager.xml +++ b/xml/System.Windows.Xps.Serialization/XpsSerializationManager.xml @@ -24,13 +24,13 @@ Manages synchronous XML Paper Specification (XPS) serializers and type converters. - manages synchronous serializers and type converters that write content to an . - - manages asynchronous serializers and type converters that store content to an . - + manages synchronous serializers and type converters that write content to an . + + manages asynchronous serializers and type converters that store content to an . + ]]> @@ -132,11 +132,11 @@ if the manager is in batch mode; otherwise, . - constructor. - + constructor. + ]]> @@ -203,20 +203,20 @@ The number of pages or documents to process at a time for font subsetting. Sets the number of pages or documents to process for font-subsetting. - enumeration value specified to the method. - -|FontSubsetterCommitPolicy|CountPolicy| -|-------------------------------|-----------------| -||Always 1 (the whole document sequence).| -||Number of documents.| -||Number of pages.| -||Not applicable.| - + enumeration value specified to the method. + +|FontSubsetterCommitPolicy|CountPolicy| +|-------------------------------|-----------------| +||Always 1 (the whole document sequence).| +||Number of documents.| +||Number of pages.| +||Not applicable.| + ]]> @@ -252,21 +252,21 @@ One of the enumeration values that specifies the font-subsetting policy. Sets the granularity at which font-subsetting is performed. - . - - When font glyphs for text in an XPS document are saved in the document package, the document text displays identically on any computer or printer. If glyphs are not saved in document and the required font is not installed on the local computer or printer, the rendering device must substitute glyphs from another font. Substituting glyphs can change the appearance of the text when a different font is used. - - determines the granularity of font-subsetting. - - (default) is the most efficient and enables the pages of all documents in a document sequence to share one font-subset that contains only the glyphs that are actually used. - - When creating interleaved documents, font-subsetting across a document sequence can require a large amount of memory to hold the complete document until the final font-subset can be determined. or can be specified to reduce application memory requirements when you create interleaved documents. - - When `policy` is , all the glyphs for all fonts that are used in the XPS document are saved, even glyphs for characters that not actually used in the text. - + . + + When font glyphs for text in an XPS document are saved in the document package, the document text displays identically on any computer or printer. If glyphs are not saved in document and the required font is not installed on the local computer or printer, the rendering device must substitute glyphs from another font. Substituting glyphs can change the appearance of the text when a different font is used. + + determines the granularity of font-subsetting. + + (default) is the most efficient and enables the pages of all documents in a document sequence to share one font-subset that contains only the glyphs that are actually used. + + When creating interleaved documents, font-subsetting across a document sequence can require a large amount of memory to hold the complete document until the final font-subset can be determined. or can be specified to reduce application memory requirements when you create interleaved documents. + + When `policy` is , all the glyphs for all fonts that are used in the XPS document are saved, even glyphs for characters that not actually used in the text. + ]]> @@ -300,11 +300,11 @@ Occurs when an XPS serializer requests a . - @@ -336,11 +336,11 @@ Occurs when a page or document finishes serialization. - diff --git a/xml/System.Windows.Xps.Serialization/XpsSerializationProgressChangedEventArgs.xml b/xml/System.Windows.Xps.Serialization/XpsSerializationProgressChangedEventArgs.xml index 9b7245b83a3..51d3fa43f71 100644 --- a/xml/System.Windows.Xps.Serialization/XpsSerializationProgressChangedEventArgs.xml +++ b/xml/System.Windows.Xps.Serialization/XpsSerializationProgressChangedEventArgs.xml @@ -110,7 +110,7 @@ is , then is the number of pages. When is , then is the number of fixed documents. + When is , then is the number of pages. When is , then is the number of fixed documents. ]]> diff --git a/xml/System.Windows.Xps/VisualsToXpsDocument.xml b/xml/System.Windows.Xps/VisualsToXpsDocument.xml index 536fe5592d9..b3cf30f31a6 100644 --- a/xml/System.Windows.Xps/VisualsToXpsDocument.xml +++ b/xml/System.Windows.Xps/VisualsToXpsDocument.xml @@ -24,23 +24,23 @@ Provides methods for writing objects to XML Paper Specification (XPS) documents or to a print queue in batch mode. - method to create an instance. - - The writes to the same target or as the that creates the . - - Each becomes a page in the document. - - - -## Examples - The following example shows how to create a visuals collator and use it to write to an XML Paper Specification (XPS) document. - + method to create an instance. + + The writes to the same target or as the that creates the . + + Each becomes a page in the document. + + + +## Examples + The following example shows how to create a visuals collator and use it to write to an XML Paper Specification (XPS) document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -78,13 +78,13 @@ Indicates that write operations can begin. - or methods. - - After the last write operation, call . - + or methods. + + After the last write operation, call . + ]]> @@ -122,11 +122,11 @@ Cancels a synchronous writing operation. - method is called and a writing operation is not in progress. - + method is called and a writing operation is not in progress. + ]]> The state of the is not compatible with a operation. @@ -165,11 +165,11 @@ Cancels an asynchronous writing operation. - method is called and a writing operation is not in progress. - + method is called and a writing operation is not in progress. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -210,13 +210,13 @@ Indicates that write operations must end. - or , call this method. - - You must call before any write operations. - + or , call this method. + + You must call before any write operations. + ]]> @@ -260,14 +260,14 @@ The that is written. Writes a synchronously to an or a . - @@ -310,11 +310,11 @@ A that represents the default printing preferences for the document. Writes a synchronously to an or a and includes a . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -432,11 +432,11 @@ A that represents the default printing preferences for the document. Writes a asynchronously to an or a and includes a . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -483,11 +483,11 @@ An object that contains the data that the caller wants to pass to the event handler. Writes a asynchronously to an or a ; also includes a and any additional information that the caller wants to pass to an event handler. - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> diff --git a/xml/System.Windows.Xps/XpsDocumentWriter.xml b/xml/System.Windows.Xps/XpsDocumentWriter.xml index a03bce4150b..5e05cb6109d 100644 --- a/xml/System.Windows.Xps/XpsDocumentWriter.xml +++ b/xml/System.Windows.Xps/XpsDocumentWriter.xml @@ -24,19 +24,19 @@ Provides methods to write to an XPS document or print queue. - has no constructor. To create an , use the static method of the class or use one of the static methods of the class. The document or the queue that creates the becomes the target to which it writes. - - - -## Examples - The following example shows how to create an instance of the class. - + has no constructor. To create an , use the static method of the class or use one of the static methods of the class. The document or the queue that creates the becomes the target to which it writes. + + + +## Examples + The following example shows how to create an instance of the class. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreatexpsdocumentwriter"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreatexpsdocumentwriter"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreatexpsdocumentwriter"::: + ]]> @@ -85,19 +85,19 @@ Returns a that can write objects to a document or print queue. - writes to the same target or as the that creates the . - - - -## Examples - The following example shows how to use the method. - + writes to the same target or as the that creates the . + + + +## Examples + The following example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -136,19 +136,19 @@ Returns a that can write objects to a document or print queue. The new . - writes to the same target or as the that creates the . - - - -## Examples - The following example shows how to use the method. - + writes to the same target or as the that creates the . + + + +## Examples + The following example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetcreateandwritetovisualscollator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetcreateandwritetovisualscollator"::: + ]]> @@ -192,13 +192,13 @@ Returns a that can write objects with settings to an XPS document or print queue. The new that writes elements with settings to the . - writes to the same target or as the that creates the . - - This method does not validate or modify the specified `documentPrintTicket` for a particular . If necessary, use the method to create a that is specific to the and valid for a specified printer. - + writes to the same target or as the that creates the . + + This method does not validate or modify the specified `documentPrintTicket` for a particular . If necessary, use the method to create a that is specific to the and valid for a specified printer. + ]]> @@ -371,18 +371,18 @@ The path of the source document. Synchronously writes a specified XPS document to the target or . - class has a singular name, an can be one or a set of multiple documents. +Although the class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the set of elements in the target or . This `Write` method reserializes the specified XPS document, which removes all content from the that isn't required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). The reserialization also removes all extensions from the markup, including any extended XPS content. By design, this `Write` method does not raise the event. - + ]]> @@ -423,14 +423,14 @@ By design, this `Write` method does not raise the An object that contains a pointer to unpaginated source material and also contains methods for paginating the material. Writes synchronously paginated content from a specified to the target or . - method to write to an XPS document. - + method to write to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithdocumentpaginator"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithdocumentpaginator"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithdocumentpaginator"::: + ]]> @@ -471,19 +471,19 @@ By design, this `Write` method does not raise the A document that is written to the . Writes synchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - - - -## Examples - The following example shows how to use this method to write to an XPS document. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + + + +## Examples + The following example shows how to use this method to write to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithfixeddocument"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocument"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocument"::: + ]]> @@ -524,19 +524,19 @@ By design, this `Write` method does not raise the A set of documents that is written to the . Writes synchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. - - - -## Examples - The following example shows how to use the method to write a sequence of XPS documents. - + class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. + + + +## Examples + The following example shows how to use the method to write a sequence of XPS documents. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithfixeddocumentsequence"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocumentsequence"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithfixeddocumentsequence"::: + ]]> @@ -615,19 +615,19 @@ By design, this `Write` method does not raise the The that is written. Writes synchronously a specified to the target or . - , use . - - - -## Examples - The following example shows how to use the method to write a to an XPS document. - + , use . + + + +## Examples + The following example shows how to use the method to write a to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritetoxpswithvisual"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithvisual"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritetoxpswithvisual"::: + ]]> @@ -670,19 +670,19 @@ By design, this `Write` method does not raise the An indication of whether notification is enabled. Writes synchronously a specified XPS document to the target or . - copies the serializedXPS document to the target or that created the . When `notificationLevel` is enabled, the first deserializes the document, next reserializes it, and then writes it to the target with progress notifications as each page is output. - - Although the class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the sequence of elements in the target or . - - If `notificationLevel` is specified as , notifications are produced only when the document is serialized, not printed. To receive notifications the document must be reserialized. When a document is reserialized, all content from the that's not required to be preserved by the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) is removed. The reserialization will also remove all extensions from the markup, including any extended XPS content. - - If `notificationLevel` is specified as the document will not be reserialized and any extended content will be preserved, even when printed. - - By design this method does not call the event. - + copies the serializedXPS document to the target or that created the . When `notificationLevel` is enabled, the first deserializes the document, next reserializes it, and then writes it to the target with progress notifications as each page is output. + + Although the class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the sequence of elements in the target or . + + If `notificationLevel` is specified as , notifications are produced only when the document is serialized, not printed. To receive notifications the document must be reserialized. When a document is reserialized, all content from the that's not required to be preserved by the [XML Paper Specification (XPS)](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) is removed. The reserialization will also remove all extensions from the markup, including any extended XPS content. + + If `notificationLevel` is specified as the document will not be reserialized and any extended content will be preserved, even when printed. + + By design this method does not call the event. + ]]> @@ -725,11 +725,11 @@ By design, this `Write` method does not raise the A that represents the default printing preferences for material. Writes synchronously paginated content from a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -772,13 +772,13 @@ By design, this `Write` method does not raise the A that represents the default printing preferences for the document. Writes synchronously a together with a to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -821,13 +821,13 @@ By design, this `Write` method does not raise the A that represents the default printing preferences for the set of documents. Writes synchronously a specified together with a to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -870,11 +870,11 @@ By design, this `Write` method does not raise the A that represents the default printing preferences for the page. Writes synchronously a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -917,13 +917,13 @@ By design, this `Write` method does not raise the A that represents the default printing preferences for the document. Writes synchronously a specified together with a to the target or . - , use . - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + , use . + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -973,15 +973,15 @@ By design, this `Write` method does not raise the The path of the source document. Writes asynchronously a specified XPS document to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the set of elements in the target or . - - This method reserializes the specified XPS document, which removes all content from the that's not required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). The reserialization also removes all extensions from the markup, including any extended XPS content. - - By design, this method does not call the event. - + class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the set of elements in the target or . + + This method reserializes the specified XPS document, which removes all content from the that's not required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/). The reserialization also removes all extensions from the markup, including any extended XPS content. + + By design, this method does not call the event. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1029,10 +1029,10 @@ By design, this `Write` method does not raise the , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example shows how to use this method to write to an XPS document. - + +## Examples + The following example shows how to use this method to write to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithdocumentpaginator"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwriteasynctoxpswithdocumentpaginator"::: @@ -1076,16 +1076,16 @@ This method stores in the task it returns all non-usage exceptions that the meth The document that is written. Writes asynchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example shows how to use this method to write to an XPS document. - + +## Examples + The following example shows how to use this method to write to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithfixeddocument"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwriteasynctoxpswithfixeddocument"::: @@ -1129,17 +1129,17 @@ This method stores in the task it returns all non-usage exceptions that the meth The set of documents that is written. Writes asynchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. - + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example shows how to use this method to write to an XPS document. - + +## Examples + The following example shows how to use this method to write to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithfixeddocumentsequence"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwriteasynctoxpswithfixeddocumentsequence"::: @@ -1221,16 +1221,16 @@ This method stores in the task it returns all non-usage exceptions that the meth The that is written. Writes asynchronously a specified to the target or . - , use . + , use . This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . - -## Examples - The following example shows how to use this method to write a to an XPS document. - + +## Examples + The following example shows how to use this method to write a to an XPS document. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwriteasynctoxpswithvisual"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwriteasynctoxpswithvisual"::: @@ -1276,19 +1276,19 @@ This method stores in the task it returns all non-usage exceptions that the meth An indication of whether notification is enabled. Writes asynchronously a specified XPS document with notification option to the target or . - copies the serialized XPS document to the target or that created the . When `notificationLevel` is enabled, the first deserializes the document, next reserializes it, and then writes it to the target with progress notifications as each page is output. - - Although the class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the sequence of elements in the target or . - - If `notificationLevel` is specified as , notifications are produced only when the document is serialized, not printed. To receive notifications, the document must be reserialized. When a document is reserialized, all content from the that's not required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) is removed. The reserialization also removes all extensions from the markup, including any extended XPS content. - - If `notificationLevel` is specified as the document will not be reserialized and any extended content will be preserved, even when printed. - - By design this method does not call the event. - + copies the serialized XPS document to the target or that created the . When `notificationLevel` is enabled, the first deserializes the document, next reserializes it, and then writes it to the target with progress notifications as each page is output. + + Although the class has a singular name, an can be one or a set of multiple documents. This method adds the elements in the source to the sequence of elements in the target or . + + If `notificationLevel` is specified as , notifications are produced only when the document is serialized, not printed. To receive notifications, the document must be reserialized. When a document is reserialized, all content from the that's not required to be preserved by the [XML Paper Specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) is removed. The reserialization also removes all extensions from the markup, including any extended XPS content. + + If `notificationLevel` is specified as the document will not be reserialized and any extended content will be preserved, even when printed. + + By design this method does not call the event. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1373,11 +1373,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A that represents the default printing preferences for the material. Writes asynchronously paginated content from a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1422,11 +1422,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + ]]> @@ -1469,13 +1469,13 @@ This method stores in the task it returns all non-usage exceptions that the meth A that represents the default printing preferences for the document. Writes asynchronously a specified together with a to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1520,11 +1520,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. - + class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. + ]]> @@ -1567,13 +1567,13 @@ This method stores in the task it returns all non-usage exceptions that the meth A that represents the default printing preferences for the set of documents. Writes asynchronously a specified together with a to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing set. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1658,11 +1658,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A that represents the default printing preferences for the page. Writes asynchronously a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1707,11 +1707,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified to the target or . - , use . - + , use . + ]]> @@ -1754,13 +1754,13 @@ This method stores in the task it returns all non-usage exceptions that the meth A that represents the default printing preferences for the document. Writes asynchronously a specified together with a to the target or . - , use . - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + , use . + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . ]]> @@ -1807,11 +1807,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously paginated content from a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -1856,13 +1856,13 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified together with a to the target or . - class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + class has a singular name, an can be one or a set of multiple documents. This method adds a to the set. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -1907,15 +1907,15 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified together with a to the target or . - writes a set of documents asynchronously to the or that created the . The data that is written includes a and additional information that the caller wants to pass to an event handler. - - Although the class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing sequence. - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + writes a set of documents asynchronously to the or that created the . The data that is written includes a and additional information that the caller wants to pass to an event handler. + + Although the class has a singular name, an can be one or a set of multiple documents. This method adds a or a set of elements to the existing sequence. + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -1960,11 +1960,11 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified together with a to the target or . - . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -2009,13 +2009,13 @@ This method stores in the task it returns all non-usage exceptions that the meth A user-specified object to identify and associate with the asynchronous operation. Writes asynchronously a specified together with a to the target or . - elements, use . - - This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. - + elements, use . + + This method does not validate or modify the specified `printTicket` for a particular . If necessary, use the method to create a that is specific to the and is valid for a specified printer. + ]]> @@ -2084,14 +2084,14 @@ This method stores in the task it returns all non-usage exceptions that the meth Occurs when a write operation finishes. - event. - + event. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritingevents"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritingevents"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritingevents"::: + ]]> @@ -2132,34 +2132,34 @@ This method stores in the task it returns all non-usage exceptions that the meth Occurs just before a or method adds a to a document or print queue. - enables an event handler to substitute a new for the one that is passed to the write operation. - - The following four and methods do not call the event: - -- (String) - -- (String, XpsDocumentNotificationLevel) - -- (String) - -- (String, XpsDocumentNotificationLevel) - - - -## Examples - The following example shows how to use the event. - + enables an event handler to substitute a new for the one that is passed to the write operation. + + The following four and methods do not call the event: + +- (String) + +- (String, XpsDocumentNotificationLevel) + +- (String) + +- (String, XpsDocumentNotificationLevel) + + + +## Examples + The following example shows how to use the event. + :::code language="csharp" source="~/snippets/csharp/System.Printing/LocalPrintServer/Overview/XpsPrintHelper.cs" id="Snippetprintmultiplefixedcontentdocuments"::: - :::code language="vb" source="~/snippets/visualbasic/System.Printing/LocalPrintServer/Overview/xpsprinthelper.vb" id="Snippetprintmultiplefixedcontentdocuments"::: - - The event handler is created in the following example. - + :::code language="vb" source="~/snippets/visualbasic/System.Printing/LocalPrintServer/Overview/xpsprinthelper.vb" id="Snippetprintmultiplefixedcontentdocuments"::: + + The event handler is created in the following example. + :::code language="csharp" source="~/snippets/csharp/System.Printing/LocalPrintServer/Overview/XpsPrintHelper.cs" id="Snippetmultiplefixedcontentdocuments_writingprintticketrequired"::: - :::code language="vb" source="~/snippets/visualbasic/System.Printing/LocalPrintServer/Overview/xpsprinthelper.vb" id="Snippetmultiplefixedcontentdocuments_writingprintticketrequired"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Printing/LocalPrintServer/Overview/xpsprinthelper.vb" id="Snippetmultiplefixedcontentdocuments_writingprintticketrequired"::: + ]]> @@ -2200,14 +2200,14 @@ This method stores in the task it returns all non-usage exceptions that the meth Occurs when the updates its progress. - event handler. - + event handler. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Documents/DocumentPaginator/PageSize/XpsSaveHelper.cs" id="Snippetwritingevents"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritingevents"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Documents/DocumentPaginator/PageSize/xpssavehelper.vb" id="Snippetwritingevents"::: + ]]> diff --git a/xml/System.Windows/Application.xml b/xml/System.Windows/Application.xml index 31e977e88c0..fc7b2e14f8f 100644 --- a/xml/System.Windows/Application.xml +++ b/xml/System.Windows/Application.xml @@ -39,13 +39,13 @@ ## Remarks is a class that encapsulates WPF application-specific functionality, including the following: -- **Application Lifetime**: , , , , , , , , , . +- **Application Lifetime**: , , , , , , , , , . -- **Application-Scope Window, Property, and Resource Management**: , , , , , , , , . +- **Application-Scope Window, Property, and Resource Management**: , , , , , , , , . -- **Command-Line Parameter and Exit Code Processing**: , , . +- **Command-Line Parameter and Exit Code Processing**: , , . -- **Navigation**: , , , , , , , , . +- **Navigation**: , , , , , , , , . implements the singleton pattern to provide shared access to its window, property, and resource scope services. Consequently, only one instance of the class can be created per . @@ -331,9 +331,9 @@ The event handler is passed a argument that contains contextual information regarding the exception, including: -- The exception (). +- The exception (). -- The from which it originated (). +- The from which it originated (). You can use this information to determine whether an exception is recoverable or not. A recoverable exception might be a , for example, while an unrecoverable exception might be a , for example. @@ -384,13 +384,13 @@ ## Remarks An application can shut down for either of the following reasons: -- The method of the object is called, either explicitly or as determined by the property. +- The method of the object is called, either explicitly or as determined by the property. - The user ends the session by logging off or shutting down. You can detect when application shutdown occurs by handling the event, and perform any additional processing as required. - You can also handle to inspect or change the application exit code when you don't need to call explicitly. The exit code is exposed from the property of the argument that's passed to the event handler. When the application stops running, the exit code is passed to the operating system for subsequent processing. + You can also handle to inspect or change the application exit code when you don't need to call explicitly. The exit code is exposed from the property of the argument that's passed to the event handler. When the application stops running, the exit code is passed to the operating system for subsequent processing. If your application handles the event and subsequently cancels it, is not raised and the application continues running in accordance with the shutdown mode. @@ -463,19 +463,19 @@ For more information about XBAP support, see [Frequently asked questions about W will first look in application-scope resources for the specified resource. Application-scope resources are managed by , and are exposed from the property. If the specified resource is not found in the set of application-scope resources, then next searches the system resources. System resources are shell resources defined by the user, and include colors, fonts, and shell configurations. These are exposed from the , , and types, respectively, as static properties. To use to acquire them, these types also expose resource key properties that are designed to be passed to ; for example, . + will first look in application-scope resources for the specified resource. Application-scope resources are managed by , and are exposed from the property. If the specified resource is not found in the set of application-scope resources, then next searches the system resources. System resources are shell resources defined by the user, and include colors, fonts, and shell configurations. These are exposed from the , , and types, respectively, as static properties. To use to acquire them, these types also expose resource key properties that are designed to be passed to ; for example, . - Because returns an object, you must cast the returned value to the appropriate type if the resource is found. + Because returns an object, you must cast the returned value to the appropriate type if the resource is found. > [!IMPORTANT] -> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions that result from calling , call instead; returns a `null` reference when a requested resource cannot be found, and does not throw an exception. +> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions that result from calling , call instead; returns a `null` reference when a requested resource cannot be found, and does not throw an exception. This method is thread safe and can be called from any thread. ## Examples - The following example shows how to use to find a resource, and to handle if the resource is not found. + The following example shows how to use to find a resource, and to handle if the resource is not found. :::code language="csharp" source="~/snippets/csharp/System.Windows/Application/FindResource/MainWindow.xaml.cs" id="Snippetapplicationcallfindresourcecodebehind"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Application/FindResource/mainwindow.xaml.vb" id="Snippetapplicationcallfindresourcecodebehind"::: @@ -615,7 +615,7 @@ For more information about XBAP support, see [Frequently asked questions about W retrieves a cookie for the specified . If the cookie can't be retrieved, a is thrown. You need to write the code to parse the cookie string into a list of name/value pairs. + retrieves a cookie for the specified . If the cookie can't be retrieved, a is thrown. You need to write the code to parse the cookie string into a list of name/value pairs. For an overview of cookies in WPF, see [Navigation Overview](/dotnet/framework/wpf/app-development/navigation-overview). @@ -938,9 +938,9 @@ For more information about XBAP support, see [Frequently asked questions about W is automatically set with a reference to the first object to be instantiated in the . + is automatically set with a reference to the first object to be instantiated in the . - You can specify a different main window by setting assigning another object to the property. + You can specify a different main window by setting assigning another object to the property. If the property of the object is set to , closing the main window causes the application to shut down. @@ -950,10 +950,10 @@ For more information about XBAP support, see [Frequently asked questions about W - You must set the property of the window you specify, otherwise it won't be shown. - The reference to the first object to be instantiated is also added as the first item to the collection. If is subsequently set with a reference to a different , the position of the item with the reference to the main window will change, while the order of items in remains the same. Consequently, always use to refer to the main window instead of the first item in . + The reference to the first object to be instantiated is also added as the first item to the collection. If is subsequently set with a reference to a different , the position of the item with the reference to the main window will change, while the order of items in remains the same. Consequently, always use to refer to the main window instead of the first item in . > [!NOTE] -> If the main window is a , and you need specific access to members, you will need to cast the value of to . +> If the main window is a , and you need specific access to members, you will need to cast the value of to . > > This property is available only from the thread that created the object. @@ -965,11 +965,11 @@ For more information about XBAP support, see [Frequently asked questions about W :::code language="csharp" source="~/snippets/csharp/System.Windows/Application/MainWindow/App.xaml.cs" id="Snippetgetapplicationmainwindowcode"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Application/MainWindow/application.xaml.vb" id="Snippetgetapplicationmainwindowcode"::: - The following example shows how to set using XAML. + The following example shows how to set using XAML. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/ApplicationMainWindowSnippets/XAML/App.xaml" id="Snippetsetapplicationmainwindowxaml"::: - The following example shows how to instantiate the in code during application startup. + The following example shows how to instantiate the in code during application startup. :::code language="csharp" source="~/snippets/csharp/System.Windows/Application/MainWindow/App1.xaml.cs" id="Snippetfirstwindowusingcodecodebehind"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Application/MainWindow/application1.xaml.vb" id="Snippetfirstwindowusingcodecodebehind"::: @@ -1234,9 +1234,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1276,9 +1276,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1318,9 +1318,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override the method. The overridden method must call in the base class if needs to be raised. + A type that derives from may override the method. The overridden method must call in the base class if needs to be raised. ]]> @@ -1361,9 +1361,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1408,9 +1408,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1455,9 +1455,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1502,9 +1502,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1549,24 +1549,24 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ## Examples - + - + - + - + - + - + ]]> @@ -1605,9 +1605,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must explicitly call in the base class if needs to be raised. + A type that derives from may override . The overridden method must explicitly call in the base class if needs to be raised. ]]> @@ -1652,9 +1652,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1699,9 +1699,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if needs to be raised. + A type that derives from may override . The overridden method must call in the base class if needs to be raised. ]]> @@ -1742,9 +1742,9 @@ For more information about XBAP support, see [Frequently asked questions about W raises the event. + raises the event. - A type that derives from may override . The overridden method must call in the base class if the event needs to be raised. + A type that derives from may override . The overridden method must call in the base class if the event needs to be raised. ]]> @@ -1782,14 +1782,14 @@ For more information about XBAP support, see [Frequently asked questions about W exposes a dictionary via that you can use to store application-scope properties. This allows you to share state amongst all code in an in a thread-safe fashion, without the need to write your own state code. + exposes a dictionary via that you can use to store application-scope properties. This allows you to share state amongst all code in an in a thread-safe fashion, without the need to write your own state code. - Properties stored in must be converted to the appropriate type returned. + Properties stored in must be converted to the appropriate type returned. The property is thread safe and is available from any thread. ## Examples - The following example shows how create and use an application-scope property using . + The following example shows how create and use an application-scope property using . :::code language="xaml" source="~/snippets/csharp/System.Windows/Application/Properties/App.xaml" id="Snippethandlestartupxaml"::: @@ -1837,30 +1837,30 @@ For more information about XBAP support, see [Frequently asked questions about W method. + By default, WPF resources are resolved at run time with respect to the entry assembly, which is identified by the value returned from the method. - The entry assembly is the assembly that is returned by and could be the following: + The entry assembly is the assembly that is returned by and could be the following: - The executable assembly in the default application domain. -- The first assembly to be executed by calling . +- The first assembly to be executed by calling . In the following cases, however, a WPF assembly cannot get a reference to the entry assembly: - An unmanaged (native) application hosts the WPF assembly. -- A managed application hosts the WPF assembly by loading it into a new application domain using a method other than . +- A managed application hosts the WPF assembly by loading it into a new application domain using a method other than . - In both of these cases, returns `null`, and the WPF assembly's resources cannot be resolved. In these cases, can be set, once only, with a reference to the assembly that should be used to resolve resources. + In both of these cases, returns `null`, and the WPF assembly's resources cannot be resolved. In these cases, can be set, once only, with a reference to the assembly that should be used to resolve resources. - can only be set once because it is unlikely that the resource assembly will change after the WPF assembly is loaded. + can only be set once because it is unlikely that the resource assembly will change after the WPF assembly is loaded. > [!NOTE] -> cannot be set when a WPF assembly can discover the entry assembly - that is, when returns a reference to an assembly rather than `null`. +> cannot be set when a WPF assembly can discover the entry assembly - that is, when returns a reference to an assembly rather than `null`. This property is thread safe and is available from any thread. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -1909,7 +1909,7 @@ For more information about XBAP support, see [Frequently asked questions about W 2. Windows -3. +3. 4. System @@ -1917,9 +1917,9 @@ For more information about XBAP support, see [Frequently asked questions about W Application-scope resources provide a simple way to support a consistent theme across your application. You can easily create a theme in XAML by using the `Application.Resources` tag. However, if your application supports multiple themes, which may contain a large number of theme elements, it might be easier to manage them using one instance for each theme. In this way, a new theme can be applied by setting the Resources property to the appropriate . - There are two considerations to make when using . First, the dictionary *key* is an object, so you need to use exactly the same object instance when both setting and getting a property value (note that the key is case-sensitive when using a string). Second, the dictionary *value* is an object, so you will need to convert the value to the desired type when getting a property value. + There are two considerations to make when using . First, the dictionary *key* is an object, so you need to use exactly the same object instance when both setting and getting a property value (note that the key is case-sensitive when using a string). Second, the dictionary *value* is an object, so you will need to convert the value to the desired type when getting a property value. - is thread safe and is available from any thread. + is thread safe and is available from any thread. @@ -1986,18 +1986,18 @@ This example illustrates how to use XAML together with application-scope resourc is called to start a WPF application. If you define your using markup, or markup and code-behind, will be called implicitly. However, if you define your using code, you will need to explicitly call . + is called to start a WPF application. If you define your using markup, or markup and code-behind, will be called implicitly. However, if you define your using code, you will need to explicitly call . - When is called, attaches a new instance to the UI thread. Next, the object's method is called, which starts a message pump to process windows messages. Finally, the object calls the object's the method to raise the event. Consequently, the application execution model has been established by the time you handle , at which point the application is considered to be running. + When is called, attaches a new instance to the UI thread. Next, the object's method is called, which starts a message pump to process windows messages. Finally, the object calls the object's the method to raise the event. Consequently, the application execution model has been established by the time you handle , at which point the application is considered to be running. - An application stops running when is called; the value of the property determines when is called, and whether it happens automatically or you need to explicitly call it. + An application stops running when is called; the value of the property determines when is called, and whether it happens automatically or you need to explicitly call it. - can be called only from the thread that creates the object. Also, cannot be called from a XBAP. + can be called only from the thread that creates the object. Also, cannot be called from a XBAP. ## Examples - The following example shows an application that uses a custom and must therefore explicitly call . + The following example shows an application that uses a custom and must therefore explicitly call . :::code language="csharp" source="~/snippets/csharp/System.Windows/Application/Run/App1.cs" id="Snippetcustomentrypointandruncode"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ApplicationRunSnippets/visualbasic/app.vb" id="Snippetcustomentrypointandruncode"::: @@ -2051,20 +2051,20 @@ This example illustrates how to use XAML together with application-scope resourc method to open the specified window after an application starts running. + This overload extends the method to open the specified window after an application starts running. - If you define a code that opens a window when it starts running, you explicitly call . + If you define a code that opens a window when it starts running, you explicitly call . If you create your using markup, or markup and code-behind, you can automatically open a window during using either of the following techniques: -- Declaratively, by setting . +- Declaratively, by setting . - Programmatically, by handling . ## Examples - The following example shows an application with a manually-created static entry point method that instantiates , before calling . + The following example shows an application with a manually-created static entry point method that instantiates , before calling . :::code language="csharp" source="~/snippets/csharp/System.Windows/Application/Run/App.cs" id="Snippetcustomentrypointandrunol1code"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ApplicationRunOL1Snippets/visualbasic/app.vb" id="Snippetcustomentrypointandrunol1code"::: @@ -2108,11 +2108,11 @@ This example illustrates how to use XAML together with application-scope resourc ## Remarks By default, an application shuts down when the Windows session ends, which occurs when a user logs off or shuts down. When this happens, Windows asks each open application to shut down. However, it is possible that an application may not be ready to shut down when this occurs. For example, an application may have data that is in an inconsistent state, or in the middle of a long-running operation. In these situations, it may be desirable to prevent the session from ending, and may be more desirable to allow users the option to decide whether or not to let the session to end. - You can detect when a session ends by handling the event. If an application needs to prevent the session from ending, the argument that is passed to the event handler exposes the that you set to `true` (the default value is `false`). + You can detect when a session ends by handling the event. If an application needs to prevent the session from ending, the argument that is passed to the event handler exposes the that you set to `true` (the default value is `false`). - If is unhandled, or is handled without being cancelled, is called and the event is raised. + If is unhandled, or is handled without being cancelled, is called and the event is raised. - To obtain more information about why the session is ending, an application can inspect , which is one of the values ( and ). + To obtain more information about why the session is ending, an application can inspect , which is one of the values ( and ). is not raised by console applications. @@ -2171,15 +2171,15 @@ This example illustrates how to use XAML together with application-scope resourc . + A cookie is an arbitrary piece of data that can be stored by an application on the client machine during application sessions (session cookies) or across application sessions (persistent cookies). You can create both types of cookies by calling . Cookie data typically takes the form of a name/value pair in the following format: `Name=Value` - You pass a string of this format to , along with the of the location for which the cookie should be set (typically, the application domain). + You pass a string of this format to , along with the of the location for which the cookie should be set (typically, the application domain). - Whether a cookie is a session cookie or a persistent cookie depends on whether the cookie string that you pass to includes an expiry date. The string for a session cookie does not include an expiry date. The string for a persistent cookie does, and must be in the following format: + Whether a cookie is a session cookie or a persistent cookie depends on whether the cookie string that you pass to includes an expiry date. The string for a session cookie does not include an expiry date. The string for a persistent cookie does, and must be in the following format: `NAME=VALUE; expires=DAY, DD-MMM-YYYY HH:MM:SS GMT` @@ -2238,20 +2238,20 @@ This example illustrates how to use XAML together with application-scope resourc is called, an application stops running. You can handle the event to detect when an application is about to stop running, to perform any appropriate processing. + When is called, an application stops running. You can handle the event to detect when an application is about to stop running, to perform any appropriate processing. - is implicitly called by Windows Presentation Foundation in the following situations: + is implicitly called by Windows Presentation Foundation in the following situations: -- When is set to . +- When is set to . -- When the is set to . +- When the is set to . - When a user ends a session and the event is either unhandled, or handled without cancellation. - Calling explicitly causes an application to shut down, regardless of the setting. However, if is set to , you must call to shut down an application. + Calling explicitly causes an application to shut down, regardless of the setting. However, if is set to , you must call to shut down an application. > [!IMPORTANT] -> When is called, the application will shut down irrespective of whether the event of any open windows is canceled. +> When is called, the application will shut down irrespective of whether the event of any open windows is canceled. This method can be called only from the thread that created the object. @@ -2303,11 +2303,11 @@ This example illustrates how to use XAML together with application-scope resourc event to set an exit code. However, if you explicitly call , and you handle only to set an exit code, you can call instead. + You can handle the event to set an exit code. However, if you explicitly call , and you handle only to set an exit code, you can call instead. This method can be called only from the thread that created the object. - See for information on exit codes. + See for information on exit codes. ]]> @@ -2343,22 +2343,22 @@ This example illustrates how to use XAML together with application-scope resourc method of the Application is called. Shut down can occur implicitly or explicitly, as specified by the value of the property. + Applications stop running only when the method of the Application is called. Shut down can occur implicitly or explicitly, as specified by the value of the property. - If you set to , Windows Presentation Foundation (WPF) implicitly calls when the last window in an application closes, even if any currently instantiated windows are set as the main window (see ). + If you set to , Windows Presentation Foundation (WPF) implicitly calls when the last window in an application closes, even if any currently instantiated windows are set as the main window (see ). - A of causes WPF to implicitly call when the closes, even if other windows are currently open. + A of causes WPF to implicitly call when the closes, even if other windows are currently open. - The lifetime of some applications may not be dependent on when the main window or last window is closed, or may not be dependent on windows at all. For these scenarios you need to set the property to , which requires an explicit method call to stop the application. Otherwise, the application continues running in the background. + The lifetime of some applications may not be dependent on when the main window or last window is closed, or may not be dependent on windows at all. For these scenarios you need to set the property to , which requires an explicit method call to stop the application. Otherwise, the application continues running in the background. - can be configured declaratively from XAML or programmatically from code. + can be configured declaratively from XAML or programmatically from code. This property is available only from the thread that created the object. ## Examples - The following example shows how to configure to specify that an application must be closed explicitly. + The following example shows how to configure to specify that an application must be closed explicitly. :::code language="xaml" source="~/snippets/csharp/System.Windows/Application/ShutdownMode/App.xaml" id="Snippetsetshutdownmodexaml"::: @@ -2407,7 +2407,7 @@ This example illustrates how to use XAML together with application-scope resourc - Initializing application-scope properties. - You can declaratively specify the main window and application-scope resources using XAML ( and , respectively). Sometimes, however, the resources or main window of your application can only be determined programmatically at run time. Additionally, application-scope properties and command-line parameters can only be used programmatically. Programmatic initialization can be performed by handling the event, including the following: + You can declaratively specify the main window and application-scope resources using XAML ( and , respectively). Sometimes, however, the resources or main window of your application can only be determined programmatically at run time. Additionally, application-scope properties and command-line parameters can only be used programmatically. Programmatic initialization can be performed by handling the event, including the following: - Acquire and process command-line parameters, which are available from the property of the class that is passed to the event handler. @@ -2418,12 +2418,12 @@ This example illustrates how to use XAML together with application-scope resourc - Instantiate and show one (or more) windows. > [!NOTE] -> Command-line parameters can also be acquired by calling the static method of the object. However, requires full trust to execute. +> Command-line parameters can also be acquired by calling the static method of the object. However, requires full trust to execute. - If you set using XAML, the main window that is created is not available from either the property or the property of the object until after the event is processed. If you need access to the main window during startup, you need to manually create a new window object from your event handler. + If you set using XAML, the main window that is created is not available from either the property or the property of the object until after the event is processed. If you need access to the main window during startup, you need to manually create a new window object from your event handler. > [!NOTE] -> If your application uses to specify a credential policy, you need to set after is raised; otherwise, WPF sets it to a default internal policy directly after the event has been raised. +> If your application uses to specify a credential policy, you need to set after is raised; otherwise, WPF sets it to a default internal policy directly after the event has been raised. The command-line arguments that are passed to the event handler are not the same as the URL query string parameters that are passed to an XAML browser application (XBAP). @@ -2475,9 +2475,9 @@ This example illustrates how to use XAML together with application-scope resourc to automatically load a UI resource when an application starts. + You can use to automatically load a UI resource when an application starts. - The following table shows the types of UI resources that can be loaded, the type of window they are opened into, and the type of application that these resources can be set as the . + The following table shows the types of UI resources that can be loaded, the type of window they are opened into, and the type of application that these resources can be set as the . |Type|Window|Application type| |----------|------------|----------------------| @@ -2486,11 +2486,11 @@ This example illustrates how to use XAML together with application-scope resourc |||Standalone/browser-hosted| |||Standalone/browser-hosted| |||Standalone/browser-hosted| -|||Standalone/browser-hosted| +|||Standalone/browser-hosted| - Typically, you set the property declaratively in XAML. However, you can set programmatically, such as from a event handler, which is useful if for applications that can only load the necessary UI resources at run time. For example, an application might wait until run time to load its resources if the name of the UI resource is stored in a configuration file. + Typically, you set the property declaratively in XAML. However, you can set programmatically, such as from a event handler, which is useful if for applications that can only load the necessary UI resources at run time. For example, an application might wait until run time to load its resources if the name of the UI resource is stored in a configuration file. - Whether you set declaratively or programmatically, the corresponding UI resource is not loaded until after the event is handled. Consequently, you won't have access to the resulting window from either the property or the property when handling . + Whether you set declaratively or programmatically, the corresponding UI resource is not loaded until after the event is handled. Consequently, you won't have access to the resulting window from either the property or the property when handling . ]]> @@ -2628,16 +2628,16 @@ This example illustrates how to use XAML together with application-scope resourc will first look in application-scope resources for the specified resource. Application-scope resources are managed by , and are exposed from the property. If the specified resource is not found in the set of application-scope resources, then next searches the system resources. System resources are shell resources defined by the user, and include colors, fonts, and shell configurations. These are exposed from the , , and types, respectively, as static properties. To use to acquire them, these types also expose resource key properties that are designed to be passed to ; for example, . + will first look in application-scope resources for the specified resource. Application-scope resources are managed by , and are exposed from the property. If the specified resource is not found in the set of application-scope resources, then next searches the system resources. System resources are shell resources defined by the user, and include colors, fonts, and shell configurations. These are exposed from the , , and types, respectively, as static properties. To use to acquire them, these types also expose resource key properties that are designed to be passed to ; for example, . - Because returns an object, you must cast the returned value to the appropriate type if the resource is found. + Because returns an object, you must cast the returned value to the appropriate type if the resource is found. This method is thread safe and can be called from any thread. ## Examples - The following example shows how to use to acquire a resource. + The following example shows how to use to acquire a resource. :::code language="xaml" source="~/snippets/csharp/System.Windows/Application/TryFindResource/App.xaml" id="Snippetapplicationcalltryfindresourcexaml"::: @@ -2681,9 +2681,9 @@ This example illustrates how to use XAML together with application-scope resourc reference is automatically added to as soon as a window is instantiated on the user interface (UI) thread; windows that are created by worker threads are not added. A reference is automatically removed after its event has been handled and before its event is raised. + A reference is automatically added to as soon as a window is instantiated on the user interface (UI) thread; windows that are created by worker threads are not added. A reference is automatically removed after its event has been handled and before its event is raised. - By default, the first item added to the property becomes the . + By default, the first item added to the property becomes the . This property is available only from the thread that created the object. diff --git a/xml/System.Windows/AttachedPropertyBrowsableForChildrenAttribute.xml b/xml/System.Windows/AttachedPropertyBrowsableForChildrenAttribute.xml index ee0f9709b2a..87d8288629a 100644 --- a/xml/System.Windows/AttachedPropertyBrowsableForChildrenAttribute.xml +++ b/xml/System.Windows/AttachedPropertyBrowsableForChildrenAttribute.xml @@ -30,29 +30,29 @@ Specifies that an attached property has a browsable scope that extends to child elements in the logical tree. - , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. - - When this .NET Framework attribute is applied to the get accessor for an attached property, this .NET Framework attribute specifies that an attached property is browsable when the attached property owner is a parent element of other elements. - - When interpreted by a designer that uses type descriptor information, the designer should add this property as a browsable property to all child elements in the logical tree, based on the parent element with this .NET Framework attribute applied. - - Generally, the browsable state parallels functionality. For example, is designated browsable on elements that are child elements of a , because includes code for checking any set values of on child elements. - - This .NET Framework attribute supports two types of tree detection modes for parent element positions: a shallow mode, and a deep mode. The shallow mode, which is the default mode for an applied .NET Framework attribute, requires that the immediate parent element be the owner type of the property in order for the attached property to be browsable. The deep mode is declared by applying the attribute with as `true`. The deep mode is less restrictive because it only requires that the owner type be somewhere in the ancestor direction of the logical tree, and therefore the attached property is browsable on all child elements, not just immediate child elements. The deep mode is applied for attached property usages where intervening elements in the logical tree should not be reported as the true parent element. Implicit collections (for example, the that is implicit in the of a ) are not considered to be parent elements for purposes of how this .NET Framework attribute declares the tree detection mode. - - This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on child elements, it is the presence and characteristics of the get accessor on the parent element that controls the true behavior. - - Whether an attached property is browsable on a child element is not an absolute guarantee that the attached property value is really processed by the parent element in some manner. Also, the value is not an absolute guarantee that the processing scope does or does not extend beyond the immediate parent element. All this is implementation specific. However, this .NET Framework attribute for reporting the browsable state is the best available mechanism for reporting the usage information and functional information for an attached property. Therefore, you can generally assume that the browsable state of an attached property is analogous to the behavior of how an attached property value on a child element is processed or interpreted by the relevant parent element in your application code. - - For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). - - -## XAML Text Usage - Members of this type are not typically used in XAML. - + , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. + + When this .NET Framework attribute is applied to the get accessor for an attached property, this .NET Framework attribute specifies that an attached property is browsable when the attached property owner is a parent element of other elements. + + When interpreted by a designer that uses type descriptor information, the designer should add this property as a browsable property to all child elements in the logical tree, based on the parent element with this .NET Framework attribute applied. + + Generally, the browsable state parallels functionality. For example, is designated browsable on elements that are child elements of a , because includes code for checking any set values of on child elements. + + This .NET Framework attribute supports two types of tree detection modes for parent element positions: a shallow mode, and a deep mode. The shallow mode, which is the default mode for an applied .NET Framework attribute, requires that the immediate parent element be the owner type of the property in order for the attached property to be browsable. The deep mode is declared by applying the attribute with as `true`. The deep mode is less restrictive because it only requires that the owner type be somewhere in the ancestor direction of the logical tree, and therefore the attached property is browsable on all child elements, not just immediate child elements. The deep mode is applied for attached property usages where intervening elements in the logical tree should not be reported as the true parent element. Implicit collections (for example, the that is implicit in the of a ) are not considered to be parent elements for purposes of how this .NET Framework attribute declares the tree detection mode. + + This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on child elements, it is the presence and characteristics of the get accessor on the parent element that controls the true behavior. + + Whether an attached property is browsable on a child element is not an absolute guarantee that the attached property value is really processed by the parent element in some manner. Also, the value is not an absolute guarantee that the processing scope does or does not extend beyond the immediate parent element. All this is implementation specific. However, this .NET Framework attribute for reporting the browsable state is the best available mechanism for reporting the usage information and functional information for an attached property. Therefore, you can generally assume that the browsable state of an attached property is analogous to the behavior of how an attached property value on a child element is processed or interpreted by the relevant parent element in your application code. + + For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + + +## XAML Text Usage + Members of this type are not typically used in XAML. + ]]> @@ -87,11 +87,11 @@ Initializes a new instance of the class. - is `false`. - + is `false`. + ]]> @@ -128,11 +128,11 @@ if the specified is equal to the current ; otherwise, . - . - + . + ]]> @@ -165,11 +165,11 @@ Returns the hash code for this .NET Framework attribute. An unsigned 32-bit integer value. - . - + . + ]]> @@ -212,15 +212,15 @@ if the attached property is browsable for all child elements in the logical tree of the parent element that owns the attached property. if the attached property is only browsable for immediate child elements of a parent element that owns the attached property. The default is . - do so with the default of as `false`. - - -## XAML Text Usage - Members of this type are not typically used in XAML. - + do so with the default of as `false`. + + +## XAML Text Usage + Members of this type are not typically used in XAML. + ]]> diff --git a/xml/System.Windows/AttachedPropertyBrowsableForTypeAttribute.xml b/xml/System.Windows/AttachedPropertyBrowsableForTypeAttribute.xml index 9ad05612f0a..5d19f4958da 100644 --- a/xml/System.Windows/AttachedPropertyBrowsableForTypeAttribute.xml +++ b/xml/System.Windows/AttachedPropertyBrowsableForTypeAttribute.xml @@ -30,19 +30,19 @@ Specifies that an attached property is browsable only for elements that derive from a specified type. - , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. - - If more than one type is specified for a .NET Framework attribute, the property is browsable if any specified type matches (logical or). The type can also be an interface. - - This .NET Framework attribute specifies `true`. - - This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on relevant elements, it is the presence and characteristics of the get accessor on the property defining element that controls the true behavior. - - For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). - + , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. + + If more than one type is specified for a .NET Framework attribute, the property is browsable if any specified type matches (logical or). The type can also be an interface. + + This .NET Framework attribute specifies `true`. + + This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on relevant elements, it is the presence and characteristics of the get accessor on the property defining element that controls the true behavior. + + For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + ]]> @@ -108,11 +108,11 @@ if the specified is equal to the current ; otherwise, . - . - + . + ]]> @@ -145,11 +145,11 @@ Returns the hash code for this .NET Framework attribute. An unsigned 32-bit integer value. - . - + . + ]]> @@ -187,11 +187,11 @@ Gets the base type that scopes the use of the attached property where this .NET Framework attribute applies. The requested . - constructor. - + constructor. + ]]> @@ -223,11 +223,11 @@ Gets a unique type identifier for this .NET Framework attribute. An object that is a unique identifier for the . - diff --git a/xml/System.Windows/AttachedPropertyBrowsableWhenAttributePresentAttribute.xml b/xml/System.Windows/AttachedPropertyBrowsableWhenAttributePresentAttribute.xml index cc24588f98d..24d31ee0e8c 100644 --- a/xml/System.Windows/AttachedPropertyBrowsableWhenAttributePresentAttribute.xml +++ b/xml/System.Windows/AttachedPropertyBrowsableWhenAttributePresentAttribute.xml @@ -30,15 +30,15 @@ Specifies that an attached property is only browsable on an element that also has another specific .NET attribute applied to its class definition. - , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. - - This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on relevant elements, it is the presence and characteristics of the get accessor on the property defining element that controls the true behavior. - - For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). - + , but the browsable state for an attached property is particularly relevant to property information for Extensible Application Markup Language (XAML), because an attached property is primarily a XAML concept. + + This .NET Framework attribute should only be applied on the get accessor of attached property definitions. Do not apply this .NET Framework attribute to the set accessor. Although intuitively it is the set operation that is being made browsable for XAML on relevant elements, it is the presence and characteristics of the get accessor on the property defining element that controls the true behavior. + + For general information on declaring attached properties, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview). + ]]> @@ -105,11 +105,11 @@ Gets the type of the .NET Framework attribute that must also be applied on a class. The .NET Framework attribute type. - value can only be set through the `attributeType` parameter of the .NET Framework attribute constructor. - + value can only be set through the `attributeType` parameter of the .NET Framework attribute constructor. + ]]> @@ -146,11 +146,11 @@ if the specified is equal to the current ; otherwise, . - . - + . + ]]> @@ -183,11 +183,11 @@ Returns the hash code for this .NET Framework attribute. An unsigned 32-bit integer value. - . - + . + ]]> diff --git a/xml/System.Windows/BaseValueSource.xml b/xml/System.Windows/BaseValueSource.xml index 2bcbb7e0c75..99e7050b337 100644 --- a/xml/System.Windows/BaseValueSource.xml +++ b/xml/System.Windows/BaseValueSource.xml @@ -23,15 +23,15 @@ Identifies the property system source of a particular dependency property value. - structure, which in turn is obtained by calling a method against a particular dependency property. - - Each value of this enumeration indicates that a particular aspect of the overall WPF property system was responsible for the effective value determination of a certain dependency property value on a specific dependency object. To learn more about the WPF property system and the precedence at which each aspect of the property system operates, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - - The value Default is not the default value of the enumeration. - + structure, which in turn is obtained by calling a method against a particular dependency property. + + Each value of this enumeration indicates that a particular aspect of the overall WPF property system was responsible for the effective value determination of a certain dependency property value on a specific dependency object. To learn more about the WPF property system and the precedence at which each aspect of the property system operates, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + + The value Default is not the default value of the enumeration. + ]]> diff --git a/xml/System.Windows/Clipboard.xml b/xml/System.Windows/Clipboard.xml index 3b6b4d06970..d3460692826 100644 --- a/xml/System.Windows/Clipboard.xml +++ b/xml/System.Windows/Clipboard.xml @@ -579,7 +579,7 @@ ## Remarks Access to data on the system Clipboard is enabled through a *data object*, that is, an object that implements the interface. A list of predefined formats is defined by the class. Use the methods specified by and fields in to examine and extract the data from the data object. - To examine the formats of data on the system Clipboard, call on the data object returned by this method. To retrieve data from the system Clipboard, call and specify the desired data format. + To examine the formats of data on the system Clipboard, call on the data object returned by this method. To retrieve data from the system Clipboard, call and specify the desired data format. The system Clipboard is shared by all applications, so data on the Clipboard is subject to change by other applications. @@ -1071,10 +1071,10 @@ is automatically cleared from the Clipboard when the application exits. + By default, data placed on the system Clipboard with is automatically cleared from the Clipboard when the application exits. > [!NOTE] -> The default behavior of clearing the Clipboard on application exit might differ from other implementations, which might leave data on the Clipboard on application exit rather than clearing it by default. Use the overload and specify the `copy` parameter as `true` if you do not want data cleared from the Clipboard on application exit. +> The default behavior of clearing the Clipboard on application exit might differ from other implementations, which might leave data on the Clipboard on application exit rather than clearing it by default. Use the overload and specify the `copy` parameter as `true` if you do not want data cleared from the Clipboard on application exit. > > provides a basic implementation of the interface. @@ -1128,7 +1128,7 @@ provides a basic implementation of the interface. determines the data object previously placed on the clipboard by the last call. + provides a basic implementation of the interface. determines the data object previously placed on the clipboard by the last call. diff --git a/xml/System.Windows/CoerceValueCallback.xml b/xml/System.Windows/CoerceValueCallback.xml index 2c8db6a7852..95adcc433a7 100644 --- a/xml/System.Windows/CoerceValueCallback.xml +++ b/xml/System.Windows/CoerceValueCallback.xml @@ -40,19 +40,19 @@ When you have this metadata, you can: -- Define a new dependency property on a new class, using either signature of , giving the metadata as the `typeMetadata` value. +- Define a new dependency property on a new class, using either signature of , giving the metadata as the `typeMetadata` value. -- Override the metadata (call ) for an existing dependency property, when you derive from the class that owns the dependency property. +- Override the metadata (call ) for an existing dependency property, when you derive from the class that owns the dependency property. -- Add an existing dependency property to a new class, using new metadata, by calling . +- Add an existing dependency property to a new class, using new metadata, by calling . Implementations of this callback should check the value in `baseValue` and determine based on either the value or the type whether this is a value that needs to be further coerced. - The for a dependency property is invoked any time that the property system or any other caller calls on a instance, specifying that property's identifier as the `dp`. + The for a dependency property is invoked any time that the property system or any other caller calls on a instance, specifying that property's identifier as the `dp`. Changes to the property value may have come from any possible participant in the property system. This includes styles, generic invalidation, triggers, property value inheritance, and local value setting. - Generally you should avoid specifying more than one for any given dependency property (overriding or adding with new metadata for a dependency property that already had a ). Only one of the callbacks will be able to act. The acting callback will be the one that was applied to the most derived class in the inheritance as compared to the caller. Other callbacks as assigned to metadata for the dependency property as it existed higher in the owner hierarchy are replaced when the metadata is overridden. + Generally you should avoid specifying more than one for any given dependency property (overriding or adding with new metadata for a dependency property that already had a ). Only one of the callbacks will be able to act. The acting callback will be the one that was applied to the most derived class in the inheritance as compared to the caller. Other callbacks as assigned to metadata for the dependency property as it existed higher in the owner hierarchy are replaced when the metadata is overridden. diff --git a/xml/System.Windows/ComponentResourceKey.xml b/xml/System.Windows/ComponentResourceKey.xml index f551c0ea3ce..f29001789a2 100644 --- a/xml/System.Windows/ComponentResourceKey.xml +++ b/xml/System.Windows/ComponentResourceKey.xml @@ -39,7 +39,7 @@ There are two ways to define a . - If you want an easily accessible key, you can define a static property on your control class code that returns a , constructed with a that exists in the external resource assembly, and a . The key can be used for defining alternate default styles for controls in an assembly, by swapping the original external resource assembly for a custom one. You can also define a named resource part within a larger control style or template to expose a customization entry point. This is particularly useful if you are defining a theme resource dictionary for your control. + If you want an easily accessible key, you can define a static property on your control class code that returns a , constructed with a that exists in the external resource assembly, and a . The key can be used for defining alternate default styles for controls in an assembly, by swapping the original external resource assembly for a custom one. You can also define a named resource part within a larger control style or template to expose a customization entry point. This is particularly useful if you are defining a theme resource dictionary for your control. You can also use the XAML [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension) in verbose syntax directly to create a loose instance of the key. This is useful if you want to declare private resources from other assemblies that are less discoverable to customize. @@ -88,7 +88,7 @@ value and value are required for proper initialization. The parameterless constructor exists primarily to support [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension) XAML usage in named parameter form. + The parameterless constructor is not generally used, because a value and value are required for proper initialization. The parameterless constructor exists primarily to support [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension) XAML usage in named parameter form. ]]> @@ -208,7 +208,7 @@ , ). + Two keys are equal if they both have the same values for all their immediate settable properties (, ). ]]> @@ -282,10 +282,10 @@ ## Remarks For XAML information, see [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension). - Typically, the string used for a value conforms to the [XamlName Grammar](/dotnet/framework/xaml-services/xamlname-grammar). + Typically, the string used for a value conforms to the [XamlName Grammar](/dotnet/framework/xaml-services/xamlname-grammar). ## Examples - The following example shows how to use the to differentiate this key from others associated with this type. + The following example shows how to use the to differentiate this key from others associated with this type. :::code language="xaml" source="~/snippets/csharp/System.Windows/ComponentResourceKey/ResourceId/generic.xaml" id="Snippetsliderstyle"::: @@ -364,7 +364,7 @@ The element is used by custom components to define keys for resources that are accessed from external assemblies, based on targeting an assembly that contains the type. Custom components often define new types which must be in the assembly where the resource is located. Generally these types have no other implementation, the types only exist in order to satisfy the lookup requirements of a . ## Examples - The following example shows how to define a including and using the [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension). This resource can then be placed in an external assembly and accessed by a key usage that requests the resource using an analogous in the request. + The following example shows how to define a including and using the [ComponentResourceKey Markup Extension](/dotnet/framework/wpf/advanced/componentresourcekey-markup-extension). This resource can then be placed in an external assembly and accessed by a key usage that requests the resource using an analogous in the request. :::code language="xaml" source="~/snippets/csharp/System.Windows/ComponentResourceKey/ResourceId/generic.xaml" id="Snippetsliderstyle"::: diff --git a/xml/System.Windows/Condition.xml b/xml/System.Windows/Condition.xml index 805d59b9ab7..04fd58d26b2 100644 --- a/xml/System.Windows/Condition.xml +++ b/xml/System.Windows/Condition.xml @@ -46,7 +46,7 @@ s and s allow you to set property values based on a set of conditions. A condition is satisfied when the property value of the element or data item matches the specified (reference equality check). If all specified conditions are satisfied, then the trigger is applied. + s and s allow you to set property values based on a set of conditions. A condition is satisfied when the property value of the element or data item matches the specified (reference equality check). If all specified conditions are satisfied, then the trigger is applied. The following is a list of cases that will cause an exception: @@ -56,9 +56,9 @@ - If the is for a , the property cannot be null. -- An exception is thrown if the specified is not valid for the type of the specified . +- An exception is thrown if the specified is not valid for the type of the specified . - Note that if the is for a , the and properties must be set. If it is for a , the and properties must be set. + Note that if the is for a , the and properties must be set. If it is for a , the and properties must be set. @@ -253,7 +253,7 @@ You create a binding and use the property to bind to a property of a certain object (the binding source object). For example, you may bind to the *Priority* property of a *Task*. For more information, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - Note that if it is a condition for a , the and properties must be set. Setting the value would cause an exception in that case. + Note that if it is a condition for a , the and properties must be set. Setting the value would cause an exception in that case. ## XAML Attribute Usage @@ -281,7 +281,7 @@ ## Examples - In the following example, the of the is bound to *Places*, an of *Place* objects. *Place* objects have properties *Name* and *State*. + In the following example, the of the is bound to *Places*, an of *Place* objects. *Place* objects have properties *Name* and *State*. Each of the displays a *Place* object. The in the example is applied to each . The s of the are specified such that if the *Name* and *State* of the *Place* data item is "Portland" and "OR" respectively, then the background of corresponding is set to Cyan. @@ -336,11 +336,11 @@ s allow you to set property values based on a set of conditions. A condition is satisfied when the value of the property (specified by the property) of the element matches the specified (reference equality check). If all specified conditions are satisfied, then the trigger is applied. + s allow you to set property values based on a set of conditions. A condition is satisfied when the value of the property (specified by the property) of the element matches the specified (reference equality check). If all specified conditions are satisfied, then the trigger is applied. If `TargetType` is not set on the style of the template that contains the triggers. Then you need to qualify the property name using the `ClassName.PropertyName` syntax. - Note that if it is a condition for a , the and properties must be set. Setting the value would cause an exception in that case. + Note that if it is a condition for a , the and properties must be set. Setting the value would cause an exception in that case. For s in s, the property should be used instead of this property. @@ -607,7 +607,7 @@ s and s allow you to set property values based on a set of conditions. A condition is satisfied when the property value of the element or data item matches the specified . If all specified conditions are satisfied, then the trigger is applied. If all specified conditions are satisfied, then the trigger is applied. + s and s allow you to set property values based on a set of conditions. A condition is satisfied when the property value of the element or data item matches the specified . If all specified conditions are satisfied, then the trigger is applied. If all specified conditions are satisfied, then the trigger is applied. diff --git a/xml/System.Windows/ContentElement.xml b/xml/System.Windows/ContentElement.xml index ce060271e64..d51b58a3f11 100644 --- a/xml/System.Windows/ContentElement.xml +++ b/xml/System.Windows/ContentElement.xml @@ -39,7 +39,7 @@ - Input: All derived classes provide support for basic input capture from keyboard, mouse, drag-and-drop operations, stylus controls, and accelerators. -- Focus: All derived classes are potentially focusable. (However, the default focusable state for the base class is `false`. For details on how to make a focusable, see .) In addition, this class contains APIs that you can use for traversing the focus across related elements. +- Focus: All derived classes are potentially focusable. (However, the default focusable state for the base class is `false`. For details on how to make a focusable, see .) In addition, this class contains APIs that you can use for traversing the focus across related elements. - Events: includes events that are related to input and focus; it also includes events for changes in state. In many cases, the events are routed events. In some cases, routed events have both tunneling and bubbling routing strategies, raised as separate events in response to the same state or condition. Also, defines APIs that can raise routed events and that can add or remove handlers to events. @@ -283,9 +283,9 @@ to `true`. Beyond this basic setting, drag-and-drop behavior is entirely implementation specific and is not defined by or any other base element class. Certain controls, for example, , do have a default behavior, but no derived classes have such a behavior. For more information on drag and drop, see [Drag and Drop Overview](/dotnet/framework/wpf/advanced/drag-and-drop-overview). + Drag-and-drop operations are not enabled by default, and must be enabled deliberately by setting to `true`. Beyond this basic setting, drag-and-drop behavior is entirely implementation specific and is not defined by or any other base element class. Certain controls, for example, , do have a default behavior, but no derived classes have such a behavior. For more information on drag and drop, see [Drag and Drop Overview](/dotnet/framework/wpf/advanced/drag-and-drop-overview). - overrides the metadata for this dependency property in its implementation. Specifically, designates that this property allows property value inheritance ( is `true` in metadata). Property value inheritance in this context means that if there are child elements with no other value for assigned through local values or styles, the value of the nearest parent element with this value assigned (again, either in styles, by default values, or a local value), then the value from that parent element is assigned to all unassigned child elements by the property system. This means that you can specify whether to allow drop operations at the root element and then propagate the value to all child elements that have not specifically assigned it a value of `false`. + overrides the metadata for this dependency property in its implementation. Specifically, designates that this property allows property value inheritance ( is `true` in metadata). Property value inheritance in this context means that if there are child elements with no other value for assigned through local values or styles, the value of the nearest parent element with this value assigned (again, either in styles, by default values, or a local value), then the value from that parent element is assigned to all unassigned child elements by the property system. This means that you can specify whether to allow drop operations at the root element and then propagate the value to all child elements that have not specifically assigned it a value of `false`. ## Dependency Property Information @@ -296,7 +296,7 @@ | Metadata properties set to `true` | None | ## Examples - The following example sets in XAML. + The following example sets in XAML. :::code language="xaml" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml" id="Snippetallowdrop"::: @@ -728,7 +728,7 @@ ## Remarks When you check whether a property is animated, note that the animation will begin and be considered animated when the first frame beyond the non-animated starting point is rendered. - If the for `animation` is `null`, then any current animations are removed and the current value of the property is held. + If the for `animation` is `null`, then any current animations are removed and the current value of the property is held. If the entire `animation` value is `null`, all animations are removed from the property and the property value reverts to its base value. However, the originally associated animation timeline is not stopped. Any other animations assigned to that timeline will continue to run. @@ -778,7 +778,7 @@ ## Remarks When you check whether a property is animated, note that the animation will begin and be considered animated when the first frame beyond the non-animated starting point is rendered. - If the for `animation` is `null`, then any current animations are removed and the current value of the property is held. + If the for `animation` is `null`, then any current animations are removed and the current value of the property is held. If the entire `animation` value is `null`, all animations are removed from the property and the property value reverts to its base value. However, the originally associated animation timeline is not stopped. Any other animations assigned to that timeline will continue to run. @@ -821,18 +821,18 @@ is `true` before you call . + To be captured, an element must be enabled. Check whether is `true` before you call . - If calling returns `true`, then is also `true`. + If calling returns `true`, then is also `true`. - If calling returns `true`, then the and events are raised, with in the event data reported as the element where the method is called. If you force capture, you might interfere with existing captures - especially with captures that relate to drag-and-drop with the mouse. + If calling returns `true`, then the and events are raised, with in the event data reported as the element where the method is called. If you force capture, you might interfere with existing captures - especially with captures that relate to drag-and-drop with the mouse. - To clear mouse capture from all elements, call with the `element` parameter provided as `null`. + To clear mouse capture from all elements, call with the `element` parameter provided as `null`. ## Examples - The following example captures the mouse or releases capture, based on whether the mouse is already captured by the element. Note that this example casts the prospective capture target element to the interface, and is thus initially calling the method. Casting to is a technique that is useful if you are unsure whether the element you want to have capture the mouse is a or a . The interface cast and the interface method call then calls the appropriate type-specific CaptureMouse implementation internally without requiring a trial cast to either or . This same casting technique works for other members that defines, for instance many of the input-related events, and other input-related methods. + The following example captures the mouse or releases capture, based on whether the mouse is already captured by the element. Note that this example casts the prospective capture target element to the interface, and is thus initially calling the method. Casting to is a technique that is useful if you are unsure whether the element you want to have capture the mouse is a or a . The interface cast and the interface method call then calls the appropriate type-specific CaptureMouse implementation internally without requiring a trial cast to either or . This same casting technique works for other members that defines, for instance many of the input-related events, and other input-related methods. :::code language="csharp" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml.cs" id="Snippetismousecaptured"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/ContentElement/CaptureMouse/page1.xaml.vb" id="Snippetismousecaptured"::: @@ -881,11 +881,11 @@ When an element captures the stylus, it receives stylus input even if the stylus is outside its bounds. The stylus is typically captured only during drag-and-drop operations. - Calling this method calls an underlying static method . The actual capture behavior is implemented by the active stylus device implementation. + Calling this method calls an underlying static method . The actual capture behavior is implemented by the active stylus device implementation. - To be captured, an element must be enabled. Check whether is `true` return before you call . + To be captured, an element must be enabled. Check whether is `true` return before you call . - If calling returns `true`, is also `true`. + If calling returns `true`, is also `true`. ]]> @@ -925,11 +925,11 @@ will return `false` if the is currently captured to another element. + will return `false` if the is currently captured to another element. - If returns `true`, then the event is raised. + If returns `true`, then the event is raised. - To release capture of a single touch from this element, use the method and specify the touch device to release. To release all touches from this element, use the method. + To release capture of a single touch from this element, use the method and specify the touch device to release. To release all touches from this element, use the method. ]]> @@ -976,7 +976,7 @@ ## Remarks A enables command handling of a specific command for this element and declares the linkage between a command, its events, and the handlers that are attached by this element. - Another typical way to populate the collection is to use methods programmatically. + Another typical way to populate the collection is to use methods programmatically. ## XAML Property Element Usage @@ -991,7 +991,7 @@ ## XAML Values *oneOrMoreCommandBindings* - One or more elements. Each of these should have a attribute set to a known command, and attributes set for the and handler implementations. For more information see . + One or more elements. Each of these should have a attribute set to a known command, and attributes set for the and handler implementations. For more information see . ]]> @@ -1039,7 +1039,7 @@ |Delegate|| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1078,7 +1078,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1125,7 +1125,7 @@ |Delegate|| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1165,7 +1165,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1214,7 +1214,7 @@ |Delegate|| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1254,7 +1254,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1301,7 +1301,7 @@ |Delegate|| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1340,7 +1340,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1381,15 +1381,15 @@ and must both be `true`. Note that nearly all derived classes are not by default. + To be focusable, and must both be `true`. Note that nearly all derived classes are not by default. Even if an element is focusable and enabled, event handling within a specific tree, (such as for a composite control) might respond to the preview focus events by not allowing focus there, thus this method would return `false`. Focus in general is governed by two separate concepts: keyboard focus and logical focus, which are not always identical. This method sets the logical focus. There is no programmatic means to set keyboard focus specifically; keyboard focus is determined by user input. For more information, see [Focus Overview](/dotnet/framework/wpf/advanced/focus-overview) and [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - If calling returns `true`, and are also `true`. + If calling returns `true`, and are also `true`. - If the related properties are not already `true`, when you call , one or more of the following events are raised in the following order: , (source is the new focus target), , , , (source is the new focus target). + If the related properties are not already `true`, when you call , one or more of the following events are raised in the following order: , (source is the new focus target), , , , (source is the new focus target). @@ -1574,7 +1574,7 @@ where `myElement` is the class name of the type that you are overriding the meta return value is always identical to the return value. If there are animations attached, then all possible animation derived values including the start and stop values are ignored, and the property value is determined based on all other possible inputs. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + If no animations are attached to the property, then the return value is always identical to the return value. If there are animations attached, then all possible animation derived values including the start and stop values are ignored, and the property value is determined based on all other possible inputs. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). ]]> @@ -1664,7 +1664,7 @@ where `myElement` is the class name of the type that you are overriding the meta - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1702,7 +1702,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1737,11 +1737,11 @@ where `myElement` is the class name of the type that you are overriding the meta method is called still gets logical focus. + Logical focus differs from keyboard focus if focus is deliberately forced by using a method call but the previous keyboard focus exists in a different scope. In this scenario, keyboard focus remains where it is and the element where a method is called still gets logical focus. A more precise interpretation of this event is that it is raised when the value of the property of an element in the route is changed from `false` to `true`. - Because this event uses bubbling routing, the element that receives focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that gained focus. + Because this event uses bubbling routing, the element that receives focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that gained focus. ## Routed Event Information @@ -1753,7 +1753,7 @@ where `myElement` is the class name of the type that you are overriding the meta |Delegate|| - There is no corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1792,7 +1792,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1832,7 +1832,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks is a similar event that tracks status changes in a property that maintains the focus state for an element; the event is raised in many of the same circumstances. - Because this event uses bubbling routing, the element that has focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has focus. + Because this event uses bubbling routing, the element that has focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has focus. This event creates an alias for the attached event for this class so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -1846,7 +1846,7 @@ where `myElement` is the class name of the type that you are overriding the meta |Delegate|| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1884,7 +1884,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1924,7 +1924,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks When an element captures the mouse, it receives mouse input even if the mouse pointer is outside its bounds. The mouse is typically captured only during drag-and-drop operations and remains captured until the drop action of the drag-and-drop operation occurs. - Because this event uses bubbling routing, the element that has capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has mouse capture. + Because this event uses bubbling routing, the element that has capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has mouse capture. This event creates an alias for the attached event for this class so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -1938,7 +1938,7 @@ where `myElement` is the class name of the type that you are overriding the meta |Delegate|| - There is no defined corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1976,7 +1976,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -2016,7 +2016,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks When an element captures the stylus, it receives stylus input even if the pointer is outside its bounds. The stylus is typically captured only during drag-and-drop operations and retains capture until the drop action of the drag-and-drop operation occurs. - Because this event uses bubbling routing, the element that has capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has capture. + Because this event uses bubbling routing, the element that has capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has capture. This event creates an alias for the attached event for this class so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -2030,7 +2030,7 @@ where `myElement` is the class name of the type that you are overriding the meta |Delegate|| - There is no defined corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -2067,7 +2067,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -2109,9 +2109,9 @@ where `myElement` is the class name of the type that you are overriding the meta |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate| of type .| +|Delegate| of type .| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -2224,7 +2224,7 @@ where `myElement` is the class name of the type that you are overriding the meta The collection of input bindings includes both input bindings that pertain to the type and also input bindings that are declared on the instance. - A related property, , maintains a collection of command bindings. These bindings differ from input bindings in that they represent the next level down of command processing - actions that are tied to known commands and class-specific handlers for them. + A related property, , maintains a collection of command bindings. These bindings differ from input bindings in that they represent the next level down of command processing - actions that are tied to known commands and class-specific handlers for them. ## XAML Property Element Usage @@ -2239,7 +2239,7 @@ where `myElement` is the class name of the type that you are overriding the meta ## XAML Values *oneOrMoreInputBindings* - One or more elements (typically the or derived classes). Each of these is expected to have a and attribute set. + One or more elements (typically the or derived classes). Each of these is expected to have a and attribute set. ]]> @@ -2286,7 +2286,7 @@ where `myElement` is the class name of the type that you are overriding the meta |Metadata properties set to `true`|None| ## Examples - The following example creates a style that includes a property setter that gives an alternate visual behavior when a is set to `false`. + The following example creates a style that includes a property setter that gives an alternate visual behavior when a is set to `false`. :::code language="xaml" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml" id="Snippetisenabledismouseover"::: @@ -2507,7 +2507,7 @@ The default implementation of this property caches the value and also calculates for the currently enabled input methods (keyboard, speech, and other input devices). + This property returns the value that is returned by the attached property for the currently enabled input methods (keyboard, speech, and other input devices). ]]> @@ -2671,9 +2671,9 @@ The default implementation of this property caches the value and also calculates event, unless a derived class has overridden to suppress the event. + Changes to the value of this property typically raise the event, unless a derived class has overridden to suppress the event. - You do not set this property directly, but you can set the focus to the element by calling , or by making a request. Either of these method calls might change this property value. + You do not set this property directly, but you can set the focus to the element by calling , or by making a request. Either of these method calls might change this property value. ## Dependency Property Information @@ -3028,7 +3028,7 @@ The default implementation of this property caches the value and also calculates , this property is only `true` if the mouse pointer is over the literal element - as it is for a hit test. If the mouse pointer is instead over a child element, in particular over elements that are part of an element's deeper template and compositing, this property will be `false`. Unless you know how a control is composited (for example, you use this property in a custom control template for a control that you define), this property might return unexpected results. For most scenarios where you are not authoring controls, use instead. + Unlike , this property is only `true` if the mouse pointer is over the literal element - as it is for a hit test. If the mouse pointer is instead over a child element, in particular over elements that are part of an element's deeper template and compositing, this property will be `false`. Unless you know how a control is composited (for example, you use this property in a custom control template for a control that you define), this property might return unexpected results. For most scenarios where you are not authoring controls, use instead. If the mouse is captured by this element, and this property is `true` at time of capture, this property will continue to return `true` until mouse capture is lost and the pointer is not over its bounds. @@ -3164,7 +3164,7 @@ The default implementation of this property caches the value and also calculates ## Examples - The following example creates a style that includes a property setter that gives an alternate visual behavior when a reports `true`. + The following example creates a style that includes a property setter that gives an alternate visual behavior when a reports `true`. :::code language="xaml" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml" id="Snippetisenabledismouseover"::: @@ -3468,9 +3468,9 @@ The default implementation of this property caches the value and also calculates , this property is only `true` if the stylus is over the element. If the stylus is instead over a child element or over elements that are part of an element's deeper compositing, this property will be `false`. + Unlike , this property is only `true` if the stylus is over the element. If the stylus is instead over a child element or over elements that are part of an element's deeper compositing, this property will be `false`. - Unless you know how a control is composited (for example, you use this property in a custom control template for a control that you define), this property might return unexpected results. For most scenarios where you are not authoring controls, use instead. + Unless you know how a control is composited (for example, you use this property in a custom control template for a control that you define), this property might return unexpected results. For most scenarios where you are not authoring controls, use instead. If this element has stylus capture and this property is `true` at the time of capture, this property remains `true` until stylus capture is lost and the stylus is not over its bounds. @@ -3683,7 +3683,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -3721,7 +3721,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -3772,7 +3772,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -3810,7 +3810,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -3845,11 +3845,11 @@ The default implementation of this property caches the value and also calculates method is called still gets logical focus. + Logical focus differs from keyboard focus if focus is deliberately forced away by using a method call but the previous keyboard focus exists in a different scope. In this scenario, keyboard focus remains where it is, and the element where a method is called still gets logical focus. A more precise interpretation of this event is that it is raised when the value of the property of an element in the route changes from `true` to `false`. - Because this event uses bubbling routing, the element that loses focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that gained focus. + Because this event uses bubbling routing, the element that loses focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that gained focus. ## Routed Event Information @@ -3862,7 +3862,7 @@ The default implementation of this property caches the value and also calculates - There is no corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -3901,7 +3901,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -3939,7 +3939,7 @@ The default implementation of this property caches the value and also calculates in the event data to determine the actual element that lost focus. + Because this event uses bubbling routing, the element that lost focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost focus. This event creates an alias for the attached event for this class, so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -3954,7 +3954,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -3991,7 +3991,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4031,7 +4031,7 @@ The default implementation of this property caches the value and also calculates ## Remarks When an element captures the mouse, it receives mouse input even if the pointer is outside its bounds. The mouse is typically captured only during drag-and-drop operations. - Because this event uses bubbling routing, the element that loses capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost capture. + Because this event uses bubbling routing, the element that loses capture might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost capture. This event creates an alias for the attached event for this class, so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -4046,7 +4046,7 @@ The default implementation of this property caches the value and also calculates - There is no defined corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4083,7 +4083,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4123,7 +4123,7 @@ The default implementation of this property caches the value and also calculates ## Remarks When an element captures the stylus, it receives stylus input even if the pointer is outside its bounds. The stylus is typically captured only during drag-and-drop operations. - Because this event uses bubbling routing, the element that loses focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost focus. + Because this event uses bubbling routing, the element that loses focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost focus. This event creates an alias for the attached event for this class, so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -4138,7 +4138,7 @@ The default implementation of this property caches the value and also calculates - There is no defined corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4175,7 +4175,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4217,9 +4217,9 @@ The default implementation of this property caches the value and also calculates |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate| of type .| +|Delegate| of type .| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4292,7 +4292,7 @@ The default implementation of this property caches the value and also calculates - Attach handlers for the event, which is not marked as handled by the controls. Notice that because this is a preview event, the route starts at the root and tunnels down to the control. -- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. +- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. ## Routed Event Information @@ -4305,7 +4305,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4342,7 +4342,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4395,7 +4395,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4432,7 +4432,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4485,7 +4485,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4522,7 +4522,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4564,7 +4564,7 @@ The default implementation of this property caches the value and also calculates This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -4575,7 +4575,7 @@ The default implementation of this property caches the value and also calculates - Attach handlers for the event, which is not marked as handled by the controls. Notice that because this is a preview event, the route starts at the root and tunnels down to the control. -- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. +- Register a handler on the control procedurally by calling and choosing the signature option that enables handlers to listen for events even if they are already marked as handled in the routed event data. ## Routed Event Information @@ -4586,7 +4586,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4624,7 +4624,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4666,7 +4666,7 @@ The default implementation of this property caches the value and also calculates This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -4679,7 +4679,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4717,7 +4717,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4768,7 +4768,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4807,7 +4807,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4849,7 +4849,7 @@ The default implementation of this property caches the value and also calculates This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -4864,7 +4864,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4902,7 +4902,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -4944,7 +4944,7 @@ The default implementation of this property caches the value and also calculates This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -4957,7 +4957,7 @@ The default implementation of this property caches the value and also calculates |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -4995,7 +4995,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5045,7 +5045,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -5082,7 +5082,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5135,7 +5135,7 @@ The default implementation of this property caches the value and also calculates - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -5172,7 +5172,7 @@ The default implementation of this property caches the value and also calculates ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5297,7 +5297,7 @@ The implementation of this method is typically to call the constructor of a spec The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5341,7 +5341,7 @@ The implementation of this method is typically to call the constructor of a spec The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5385,7 +5385,7 @@ The implementation of this method is typically to call the constructor of a spec The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5429,7 +5429,7 @@ The implementation of this method is typically to call the constructor of a spec The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5473,7 +5473,7 @@ The implementation of this method is typically to call the constructor of a spec The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5521,7 +5521,7 @@ The implementation of this method is typically to call the constructor of a spec ## Remarks This method, although virtual, does have a default implementation that raises the event. - This On\* method implementation is intended to raise the event, and this same method implementation is invoked internally to raise the event when the property value changes. The implementation differs from some other Windows Presentation Foundation (WPF) On\* implementations, which only provide a convenient way to add class handling for that event. + This On\* method implementation is intended to raise the event, and this same method implementation is invoked internally to raise the event when the property value changes. The implementation differs from some other Windows Presentation Foundation (WPF) On\* implementations, which only provide a convenient way to add class handling for that event. ## Notes to inheritors @@ -5571,7 +5571,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5615,7 +5615,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5659,7 +5659,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -5698,7 +5698,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -5737,7 +5737,7 @@ Note that by default a is not foc dependency property changes. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -5778,7 +5778,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -5819,7 +5819,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -5897,7 +5897,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -5938,7 +5938,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -5979,7 +5979,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore, you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -6020,7 +6020,7 @@ Note that by default a is not foc dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore you cannot mark it as handled in the class handler. + This virtual method is raised when the value of the dependency property changes its value. The virtual method is raised first and can manipulate the event data as necessary. Then the event is raised with that same event data instance. Notice that the event is not a routed event. Therefore you cannot mark it as handled in the class handler. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. You may call base either before or after your special handling, depending on your requirements. @@ -6061,13 +6061,13 @@ Note that by default a is not foc is not invoked. + Keystrokes are handled by a dedicated input manager. Other programming features that rely on keystrokes, for example, input and command bindings, might handle the keystroke before it is exposed as a general keystroke. If these input system features mark the event as handled, then is not invoked. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6107,13 +6107,13 @@ Note that by default a is not foc is not invoked. + Keystrokes are handled by a dedicated input manager. Other programming features that rely on keystrokes, for example, input and command bindings, might handle the keystroke before it is exposed as a general keystroke. If these input system features mark the event as handled, then is not invoked. This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation. The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6207,7 +6207,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6251,7 +6251,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6295,7 +6295,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6334,7 +6334,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -6373,11 +6373,11 @@ Note that by default a is not foc event as handled, is not invoked. + Mouse button actions are also handled by a dedicated input manager. Other programming features that rely on mouse button actions, such as input and command bindings, might invoke handlers for the action before it is exposed as a general mouse button action. If these input system features mark the event as handled, is not invoked. If you use this class handler to mark the event as handled, you potentially impact the following events: and . Either of these events may be raised on the receiving element when is received. - If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button down actions. This behavior might be unwanted; therefore, use caution when you use this virtual method to mark events as handled. + If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button down actions. This behavior might be unwanted; therefore, use caution when you use this virtual method to mark events as handled. Each of the button-specific direct events also has a virtual On\* method; consider whether overriding these button-specific class handlers might be more appropriate. @@ -6385,7 +6385,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6511,9 +6511,9 @@ Note that by default a is not foc ## Remarks The event appears to travel a bubbling route but actually travels in an indirect way. is the underlying event that is bubble routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . - Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling the base implementation; however, this override disables the event. + Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling the base implementation; however, this override disables the event. ]]> @@ -6554,7 +6554,7 @@ Note that by default a is not foc ## Remarks The event appears to travel a bubbling route but actually travels in an indirect way. is the underlying event that is bubble routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . ]]> @@ -6597,7 +6597,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6639,9 +6639,9 @@ Note that by default a is not foc ## Remarks The event appears to travel a bubbling route but actually travels in an indirect way. is the underlying event that is bubble routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . - Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling base; however, this override disables the context menu services on your control, which are part of the default behavior. + Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling base; however, this override disables the context menu services on your control, which are part of the default behavior. ]]> @@ -6682,7 +6682,7 @@ Note that by default a is not foc ## Remarks The event appears to travel a bubbling route but actually travels in an indirect way. is the underlying event that is bubble routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . ]]> @@ -6721,11 +6721,11 @@ Note that by default a is not foc event as handled, is not invoked. + Mouse button actions are also handled by a dedicated input manager. Other programming features that rely on mouse button actions, such as input and command bindings, might invoke handlers for the action before it is exposed as a general mouse button action. If these input system features mark the event as handled, is not invoked. If you use this class handler to mark the event as handled, you potentially impact the following events: and . Either of these events might be raised on the receiving element when is received. - If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button up actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. + If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button up actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. Each of the button-specific direct events also has a virtual On\* method; consider whether overriding these button-specific class handlers might be more appropriate. @@ -6733,7 +6733,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6776,7 +6776,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -6820,7 +6820,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -6864,7 +6864,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -6908,7 +6908,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -6952,7 +6952,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -6996,7 +6996,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7040,7 +7040,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7084,7 +7084,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7128,7 +7128,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7172,7 +7172,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7212,11 +7212,11 @@ Note that by default a is not foc event as handled, is not invoked. + Mouse button actions are also handled by a dedicated input manager. Other programming features that rely on mouse button actions, such as input and command bindings, might invoke handlers for the action before it is exposed as a general mouse button action. If these input system features mark the event as handled, is not invoked. If you use this class handler to mark the event as handled, you potentially impact the following events: and . Either of these events may be raised on the receiving element when is received. - If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button down actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. + If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button down actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. Each of the button-specific direct events also has a virtual On\* method; consider whether overriding these button-specific class handlers might be more appropriate. @@ -7224,7 +7224,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7266,9 +7266,9 @@ Note that by default a is not foc ## Remarks The event appears to travel a tunneling route but actually travels in an indirect way. is the underlying event that is tunnel routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . - Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling the base implementation; however, this override disables the event. + Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling the base implementation; however, this override disables the event. ]]> @@ -7309,7 +7309,7 @@ Note that by default a is not foc ## Remarks The event appears to travel a tunneling route but actually travels in an indirect way. is the underlying event that is tunnel routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . ]]> @@ -7352,7 +7352,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7394,9 +7394,9 @@ Note that by default a is not foc ## Remarks The event appears to travel a tunneling route but actually travels in an indirect way. is the underlying event that is tunnel routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . - Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling base; however, this override disables the context menu services on your control, which are part of the default behavior. + Alternatively, you can override this method in order to change event handling for a specific mouse state. Whether you choose to call the base implementation depends on your scenario. Failing to call base disables default input handling for that mouse event on ancestor classes that also expect to invoke . For example, you can derive from and override in your derived class without calling base; however, this override disables the context menu services on your control, which are part of the default behavior. ]]> @@ -7437,7 +7437,7 @@ Note that by default a is not foc ## Remarks The event appears to travel a tunneling route but actually travels in an indirect way. is the underlying event that is tunnel routed, and each along the event route uses identical handling to raise the direct routed event . Although you can mark the event as handled for purposes of this element, the handled state does not perpetuate to other elements along the event route. However, you might want to mark the event as handled in order to prevent general instance handlers (those that did not specify `handledEventsToo`) from being invoked. - The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . + The default implementation for general mouse event handling in listens for and converts it to an appropriate local event. If you want to override this logic, you must create a derived class. In the static constructor of your derived class, register an alternative class handler for . You cannot change the mouse handling behavior of by overriding . ]]> @@ -7476,11 +7476,11 @@ Note that by default a is not foc event as handled, is not invoked. + Mouse button actions are also handled by a dedicated input manager. Other programming features that rely on mouse button actions, such as input and command bindings, might invoke handlers for the action before it is exposed as a general mouse button action. If these input system features mark the event as handled, is not invoked. If you use this class handler to mark the event as handled, you potentially impact the following events: and . Either of these events might be raised on the receiving element when is received. - If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button up actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. + If you mark this event as handled in class handling, subevents are still raised; however, they pass the handled state in the event data. If the event is handled in class handling, instance handlers for the subevents are not invoked unless you explicitly use with `handledEventsToo` `true` in order to attach handlers. Class handlers also are not invoked unless those class handlers were registered with the signature with `handledEventsToo` `true`. By handling , you are implying that your class handling accounted for all possible mouse button up actions. This behavior might be unwanted; Therefore, use caution when you use this virtual method to mark events as handled. Each of the button-specific direct events also has a virtual On\* method; consider whether overriding these button-specific class handlers might be more appropriate. @@ -7488,7 +7488,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -7532,7 +7532,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7576,7 +7576,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7620,7 +7620,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7664,7 +7664,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7708,7 +7708,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7752,7 +7752,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7796,7 +7796,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7840,7 +7840,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7884,7 +7884,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7928,7 +7928,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -7972,7 +7972,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -8016,7 +8016,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked. ]]> @@ -8056,7 +8056,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8094,7 +8094,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8132,7 +8132,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8175,7 +8175,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8219,7 +8219,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8263,7 +8263,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8307,7 +8307,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8351,7 +8351,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8437,7 +8437,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8481,7 +8481,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8567,7 +8567,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8611,7 +8611,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8655,7 +8655,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8699,7 +8699,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8743,7 +8743,7 @@ Note that by default a is not foc The purpose of this method is similar to the common language runtime (CLR) event pattern On\* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On\* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases. - Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. + Either by overriding this method or by registering class handlers with , derived classes of can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. ]]> @@ -8782,7 +8782,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8820,7 +8820,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8858,7 +8858,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8896,7 +8896,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -8934,7 +8934,7 @@ Note that by default a is not foc method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. + The method has no default implementation. Override in a derived class to handle the event. Be sure to call the base class' method so that base classes receive the event. ]]> @@ -9023,7 +9023,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9060,7 +9060,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9108,7 +9108,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9145,7 +9145,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9193,7 +9193,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9230,7 +9230,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9278,7 +9278,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9315,7 +9315,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9365,7 +9365,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9402,7 +9402,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9440,7 +9440,7 @@ Note that by default a is not foc in the event data to determine the actual element that has focus. + Because this event uses tunneling routing, the element that has focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that has focus. This event creates an alias for the attached event for this class, so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -9455,7 +9455,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9493,7 +9493,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9546,7 +9546,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9584,7 +9584,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9637,7 +9637,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9674,7 +9674,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9712,7 +9712,7 @@ Note that by default a is not foc in the event data to determine the actual element that lost focus. + Because this event uses tunneling routing, the element that lost focus might be a child element instead of the element where the event handler is actually attached. Check the in the event data to determine the actual element that lost focus. This event creates an alias for the attached event for this class, so that is part of the class members list when is inherited as a base element. Event handlers that are attached to the event are attached to the underlying attached event and receive the same event data instance. @@ -9727,7 +9727,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9765,7 +9765,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9815,7 +9815,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9852,7 +9852,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9894,7 +9894,7 @@ Note that by default a is not foc This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -9907,7 +9907,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -9945,7 +9945,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -9987,7 +9987,7 @@ Note that by default a is not foc This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -10000,7 +10000,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10037,7 +10037,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10090,7 +10090,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10127,7 +10127,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10169,7 +10169,7 @@ Note that by default a is not foc This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -10182,7 +10182,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10220,7 +10220,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10262,7 +10262,7 @@ Note that by default a is not foc This event is one of several related events that report the mouse-button specifics of an underlying event, which is an attached event that is processed by each element along an event route. - The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. + The arguments of this event expose the arguments of the underlying event. If that event is marked as handled along the event route, the mouse-button specific events are still raised; however, handlers of the mouse-button specific events must be added by explicitly calling , with the option to handle events that are already marked as handled, in order to be listeners to the event. Conceptually, think of this event (and other mouse-button events on ) to be a mouse "service" (with the service definition provided by the class). The event adds the convenience of not needing to check the mouse button states (left-right, up-down) of the original mouse events in the event data. For more advanced scenarios, such as checking for states of non-standard buttons, you might need to use the APIs on the class rather than those on . @@ -10275,7 +10275,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10313,7 +10313,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10363,7 +10363,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10400,7 +10400,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10453,7 +10453,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10490,7 +10490,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10540,7 +10540,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10577,7 +10577,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10630,7 +10630,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10668,7 +10668,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10721,7 +10721,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10758,7 +10758,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10811,7 +10811,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10848,7 +10848,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10901,7 +10901,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -10938,7 +10938,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -10991,7 +10991,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11028,7 +11028,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11081,7 +11081,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11118,7 +11118,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11171,7 +11171,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11208,7 +11208,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11263,7 +11263,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11300,7 +11300,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11353,7 +11353,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11390,7 +11390,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11445,7 +11445,7 @@ Note that by default a is not foc - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11483,7 +11483,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11519,7 +11519,7 @@ Note that by default a is not foc ## Remarks By default, the and events do not occur until a finger touches the screen and moves. Pressing a finger on the screen and holding it without moving it causes the press and hold behavior of a . The press and hold behavior is equivalent to a mouse right-click. - To cause the and events to occur as soon as a finger touches the screen, set the attached property to `false` for this element. + To cause the and events to occur as soon as a finger touches the screen, set the attached property to `false` for this element. ## Routed Event Information @@ -11528,11 +11528,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Tunneling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11604,11 +11604,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Tunneling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11677,11 +11677,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Tunneling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding bubbling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11758,7 +11758,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11795,7 +11795,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -11834,7 +11834,7 @@ Note that by default a is not foc The cursor being referred to by this event name is not necessarily the text cursor (sometimes known as the insertion point). Instead, the cursor in this context is the object that declares the onscreen graphical display related to several possible input-related devices or concepts in Windows programming. That object is represented by the class in WPF. The WPF input system enables you to change this cursor when it represents the onscreen position of the mouse pointer. You can use predefined values from the enumeration, or you can declare a custom cursor as an image file. - Listening for the event is not an efficient technique for cursor management. Instead, each element should define its own cursor behavior with and . You should only rely on if you are not using the WPF framework-level base elements, or in extraordinary circumstances where defining cursor behavior on a per-element basis does not meet your needs. For more information on implementing cursor behavior in response to , see . + Listening for the event is not an efficient technique for cursor management. Instead, each element should define its own cursor behavior with and . You should only rely on if you are not using the WPF framework-level base elements, or in extraordinary circumstances where defining cursor behavior on a per-element basis does not meet your needs. For more information on implementing cursor behavior in response to , see . ## Routed Event Information @@ -11847,7 +11847,7 @@ Note that by default a is not foc - There is no defined corresponding tunneling event. -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -11885,7 +11885,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12004,7 +12004,7 @@ Note that by default a is not foc before you call this method. + If this element did not hold the capture, calling this method has no effect. Consider checking the value of before you call this method. @@ -12052,7 +12052,7 @@ Note that by default a is not foc before you call this method. + If this element did not hold the capture, calling this method has no effect. Consider checking the value of before you call this method. ]]> @@ -12139,7 +12139,7 @@ Note that by default a is not foc Neither `routedEvent` nor `handler` may be `null`. Attempting to provide either value as `null` will raise an exception. - This method ignores the `handledEventsToo` parameter information, which is provided if the handler was first added with the signature that enables handling of already-handled events. Either type of handler is removed. + This method ignores the `handledEventsToo` parameter information, which is provided if the handler was first added with the signature that enables handling of already-handled events. Either type of handler is removed. ]]> @@ -12184,7 +12184,7 @@ Note that by default a is not foc is locally set. + This will return `true` if is locally set. This `ShouldSerialize` method is provided because the property does not have a simple default value. This method indicates whether the property has changed from its default value. You typically invoke this method if you are either developing a designer or developing your own control incorporating a . @@ -12232,7 +12232,7 @@ Note that by default a is not foc is locally set. + This will return `true` if is locally set. This `ShouldSerialize` method is provided because the property does not have a simple default value. This method indicates whether the property has changed from its default value. You typically invoke this method if you are either developing a designer or developing your own control incorporating a . @@ -12289,7 +12289,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12327,7 +12327,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12380,7 +12380,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12418,7 +12418,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12471,7 +12471,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12508,7 +12508,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12563,7 +12563,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12600,7 +12600,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12653,7 +12653,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12690,7 +12690,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12743,7 +12743,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12780,7 +12780,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12835,7 +12835,7 @@ Note that by default a is not foc |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12872,7 +12872,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -12925,7 +12925,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -12962,7 +12962,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -13015,7 +13015,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13052,7 +13052,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -13107,7 +13107,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13144,7 +13144,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -13197,7 +13197,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13234,7 +13234,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -13295,7 +13295,7 @@ Note that by default a is not foc - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13332,7 +13332,7 @@ Note that by default a is not foc ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -13368,7 +13368,7 @@ Note that by default a is not foc ## Remarks By default, the and events do not occur until a finger touches the screen and moves. Pressing a finger on the screen and holding it without moving it causes the press and hold behavior of a . The press and hold behavior is equivalent to a mouse right-click. - To cause the and events to occur as soon as a finger touches the screen, set the attached property to `false` for this element. + To cause the and events to occur as soon as a finger touches the screen, set the attached property to `false` for this element. ## Routed Event Information @@ -13377,11 +13377,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13454,9 +13454,9 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Direct| -|Delegate| of type .| +|Delegate| of type .| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13637,9 +13637,9 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Direct| -|Delegate| of type .| +|Delegate| of type .| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13708,11 +13708,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -13781,11 +13781,11 @@ Note that by default a is not foc |-----------------------------------|--------------------------------------------------------| |Identifier field|| |Routing strategy|Bubbling| -|Delegate| of type .| +|Delegate| of type .| - The corresponding tunneling event is . -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> diff --git a/xml/System.Windows/ContentOperations.xml b/xml/System.Windows/ContentOperations.xml index 664c69bb910..a9a14d7cf08 100644 --- a/xml/System.Windows/ContentOperations.xml +++ b/xml/System.Windows/ContentOperations.xml @@ -27,7 +27,7 @@ should be used instead of members of , if is available. + For most content element scenarios, the property should be used instead of members of , if is available. ]]> @@ -71,7 +71,7 @@ ## Remarks Most practical derived classes in WPF are also a derived class. For these classes, the property should be used instead. - returns the parent element in the logical tree, which might not be the same element as returned by . exists specifically to correct for certain architectural issues whereby a class that is not also a exists in a tree that is not strictly speaking either the logical tree or the visual tree. + returns the parent element in the logical tree, which might not be the same element as returned by . exists specifically to correct for certain architectural issues whereby a class that is not also a exists in a tree that is not strictly speaking either the logical tree or the visual tree. ]]> @@ -112,7 +112,7 @@ hosting and content model on a class. The class uses this method internally to hook up its content property. + Use this method to help define a hosting and content model on a class. The class uses this method internally to hook up its content property. ]]> diff --git a/xml/System.Windows/CornerRadius.xml b/xml/System.Windows/CornerRadius.xml index da7fdd990ac..ef32af4922e 100644 --- a/xml/System.Windows/CornerRadius.xml +++ b/xml/System.Windows/CornerRadius.xml @@ -37,7 +37,7 @@ , , , and , corresponding to the individual corners of the rectangle. Each is a structure that can be set independently of the others. + This class has four properties, , , , and , corresponding to the individual corners of the rectangle. Each is a structure that can be set independently of the others. The radiuses cannot be negative. @@ -261,11 +261,11 @@ ## Examples - + - + - + ]]> diff --git a/xml/System.Windows/DataFormats.xml b/xml/System.Windows/DataFormats.xml index 5d85e44c8d3..c8bf59e055a 100644 --- a/xml/System.Windows/DataFormats.xml +++ b/xml/System.Windows/DataFormats.xml @@ -24,39 +24,39 @@ Provides a set of predefined data format names that can be used to identify data formats available in the clipboard or drag-and-drop operations. - class and other classes that implement the interface use the static formats defined by to describe each data format that is stored in a data object. Data objects are typically used for transferring data to and from the system clipboard, and in drag-and-drop operations. - - The following table lists the values of the static data format fields provided by . These field values are provided for informational purposes only; in general, code should always refer to the appropriate field, rather than hard-coded strings. - -|Field|Field Value|Description| -|-----------|-----------------|-----------------| -||"Bitmap"|Specifies a Microsoft Windows bitmap data format.| -||"CSV"|Specifies a comma-separated value (CSV) data format.| -||"DeviceIndependentBitmap"|Specifies the device-independent bitmap (DIB) data format.| -||"DataInterchangeFormat"|Specifies the Windows Data Interchange Format (DIF) data format.| -||"EnhancedMetafile"|Specifies the Windows enhanced metafile format.| -||"FileDrop"|Specifies the Windows file drop format.| -||"HTML Format"|Specifies the HTML data format.| -||"Locale"|Specifies the Windows locale (culture) data format.| -||"MetaFilePict"|Specifies the Windows metafile picture data format.| -||"OEMText"|Specifies the standard Windows OEM text data format.| -||"Palette"|Specifies the Windows palette data format.| -||"PenData"|Specifies the Windows pen data format.| -||"RiffAudio"|Specifies the Resource Interchange File Format (RIFF) audio data format.| -||"Rich Text Format"|Specifies the Rich Text Format (RTF) data format.| -||"PersistentObject"|Specifies a data format that encapsulates any type of serializable data objects.| -||"System.String"|Specifies the common language runtime (CLR) string class data format.| -||"SymbolicLink"|Specifies the Windows symbolic link data format.| -||"Text"|Specifies the ANSI text data format.| -||"TaggedImageFileFormat"|Specifies the Tagged Image File Format (TIFF) data format.| -||"UnicodeText"|Specifies the Unicode text data format.| -||"WaveAudio"|Specifies the wave audio data format.| -||"Xaml"|Specifies the Extensible Application Markup Language (XAML) data format.| -||"XamlPackage"|Specifies the Extensible Application Markup Language (XAML) package data format.| - + class and other classes that implement the interface use the static formats defined by to describe each data format that is stored in a data object. Data objects are typically used for transferring data to and from the system clipboard, and in drag-and-drop operations. + + The following table lists the values of the static data format fields provided by . These field values are provided for informational purposes only; in general, code should always refer to the appropriate field, rather than hard-coded strings. + +|Field|Field Value|Description| +|-----------|-----------------|-----------------| +||"Bitmap"|Specifies a Microsoft Windows bitmap data format.| +||"CSV"|Specifies a comma-separated value (CSV) data format.| +||"DeviceIndependentBitmap"|Specifies the device-independent bitmap (DIB) data format.| +||"DataInterchangeFormat"|Specifies the Windows Data Interchange Format (DIF) data format.| +||"EnhancedMetafile"|Specifies the Windows enhanced metafile format.| +||"FileDrop"|Specifies the Windows file drop format.| +||"HTML Format"|Specifies the HTML data format.| +||"Locale"|Specifies the Windows locale (culture) data format.| +||"MetaFilePict"|Specifies the Windows metafile picture data format.| +||"OEMText"|Specifies the standard Windows OEM text data format.| +||"Palette"|Specifies the Windows palette data format.| +||"PenData"|Specifies the Windows pen data format.| +||"RiffAudio"|Specifies the Resource Interchange File Format (RIFF) audio data format.| +||"Rich Text Format"|Specifies the Rich Text Format (RTF) data format.| +||"PersistentObject"|Specifies a data format that encapsulates any type of serializable data objects.| +||"System.String"|Specifies the common language runtime (CLR) string class data format.| +||"SymbolicLink"|Specifies the Windows symbolic link data format.| +||"Text"|Specifies the ANSI text data format.| +||"TaggedImageFileFormat"|Specifies the Tagged Image File Format (TIFF) data format.| +||"UnicodeText"|Specifies the Unicode text data format.| +||"WaveAudio"|Specifies the wave audio data format.| +||"Xaml"|Specifies the Extensible Application Markup Language (XAML) data format.| +||"XamlPackage"|Specifies the Extensible Application Markup Language (XAML) package data format.| + ]]> @@ -87,15 +87,15 @@ Specifies a Microsoft Windows bitmap data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -126,15 +126,15 @@ Specifies a comma-separated value (CSV) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -165,15 +165,15 @@ Specifies the DIB data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -204,15 +204,15 @@ Specifies the Windows Data Interchange Format (DIF) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -243,15 +243,15 @@ Specifies the Windows enhanced metafile format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -282,15 +282,15 @@ Specifies the Windows file drop format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -303,11 +303,11 @@ Returns a object that defines a name and numeric ID for a specified data format. - @@ -349,11 +349,11 @@ Returns a object that defines a name and numeric ID for the specified data format. The desired data format is specified by numeric ID. A object that contains the numeric ID and the name of the requested data format. - @@ -395,11 +395,11 @@ Returns a object that defines a name and numeric ID for the specified data format. The desired data format is specified by name (a string). A object that contains the numeric ID and the name of the requested data format. - @@ -433,13 +433,13 @@ Specifies the HTML data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -470,13 +470,13 @@ Specifies the Windows locale (culture) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -507,15 +507,15 @@ Specifies the Windows metafile picture data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -546,13 +546,13 @@ Specifies the standard Windows OEM text data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -583,13 +583,13 @@ Specifies the Windows palette data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -620,15 +620,15 @@ Specifies the Windows pen data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -659,15 +659,15 @@ Specifies the Resource Interchange File Format (RIFF) audio data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -698,15 +698,15 @@ Specifies the Rich Text Format (RTF) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -737,13 +737,13 @@ Specifies a data format that encapsulates any type of serializable data objects. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -774,13 +774,13 @@ Specifies the common language runtime (CLR) string class data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -811,15 +811,15 @@ Specifies the Windows symbolic link data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -850,13 +850,13 @@ Specifies the ANSI text data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -887,15 +887,15 @@ Specifies the Tagged Image File Format (TIFF) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -926,15 +926,15 @@ Specifies the Unicode text data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -965,13 +965,13 @@ Specifies the wave audio data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -1002,15 +1002,15 @@ Specifies the Extensible Application Markup Language (XAML) data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> @@ -1041,13 +1041,13 @@ Specifies the Extensible Application Markup Language (XAML) package data format. - class and other classes that implement the interface to describe an available data format. - - Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. - + class and other classes that implement the interface to describe an available data format. + + Use this field with the method to add data with a corresponding format to a data object; use this field with the method to retrieve data in the corresponding format. To check whether a data object contains data in this format, use the method to query for the format. + ]]> diff --git a/xml/System.Windows/DataObject.xml b/xml/System.Windows/DataObject.xml index 2d6f95e63d5..78d7be95c93 100644 --- a/xml/System.Windows/DataObject.xml +++ b/xml/System.Windows/DataObject.xml @@ -358,7 +358,7 @@ ## Remarks The event occurs when a copy operation has finished converting the selected content into all specified data formats, has stored all data formats in the associated data object, and is ready to put the data object on the system Clipboard or to begin a drag operation. - Use this event to inspect or modify a data object after a copy operation completes, and before proceeding with subsequent operations. The entire copy operation can be canceled by calling . + Use this event to inspect or modify a data object after a copy operation completes, and before proceeding with subsequent operations. The entire copy operation can be canceled by calling . ]]> @@ -402,7 +402,7 @@ ## Remarks Use this event to inspect a data object before the data is pasted, and possibly to decide on an alternate course of action, such as: -- **Cancel the Paste** - Cancel the entire paste operation by calling the method. +- **Cancel the Paste** - Cancel the entire paste operation by calling the method. - **Select an Alternate Format** - Change the selected paste format by specifying a new value for the property. The newly selected format must by supported by the data object to be pasted. @@ -411,7 +411,7 @@ - **Insert a New Format** - If you determine that the paste data object does not support the desired format, update the data object to include a version of the data in the desired format. Custom data converters are often used as part of this process. - Changing the content of a paste data object () does not change the data stored on the system Clipboard; any such changes will apply only to the data object associated with the associated paste command. + Changing the content of a paste data object () does not change the data stored on the system Clipboard; any such changes will apply only to the data object associated with the associated paste command. ]]> @@ -455,7 +455,7 @@ ## Remarks The event occurs as part of a copy or drag command, once for each of the data formats to add to the associated data object. Typically, this event is connected to a content control, such as . - A handler for this event can be used to selectively prevent unwanted data formats from being added to the data object, thus eliminating data conversion processing for redundant data formats and improving the overall performance of a copy operation. To skip a particular data format, call the method and specify the format to skip in the property. Calling the method for this event does not cancel the associated copy or drag command. + A handler for this event can be used to selectively prevent unwanted data formats from being added to the data object, thus eliminating data conversion processing for redundant data formats and improving the overall performance of a copy operation. To skip a particular data format, call the method and specify the format to skip in the property. Calling the method for this event does not cancel the associated copy or drag command. ]]> @@ -725,7 +725,7 @@ prior to the copy operation, change, remove or add data formats, or cancel the entire copy operation by calling . + This event is intended to provide an opportunity for applications to inspect the contents of the prior to the copy operation, change, remove or add data formats, or cancel the entire copy operation by calling . ## Routed Event Information @@ -855,12 +855,12 @@ method. + The following example uses this method to first check whether a specified data format is available (natively or by auto-convert); if the specified format is available, the example retrieves the data by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Clipboard/Overview/Window1.xaml.cs" id="Snippet_dragdrop_getspecificdataformat"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Clipboard/Overview/window1.xaml.vb" id="Snippet_dragdrop_getspecificdataformat"::: - The following example code uses the method to first check if a specified data format is available natively (auto-convertible data formats are filtered); if the specified format is available, the example retrieves the data by using the method. + The following example code uses the method to first check if a specified data format is available natively (auto-convertible data formats are filtered); if the specified format is available, the example retrieves the data by using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Clipboard/Overview/Window1.xaml.cs" id="Snippet_dragdrop_getspecificdataformat_native"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Clipboard/Overview/window1.xaml.vb" id="Snippet_dragdrop_getspecificdataformat_native"::: @@ -968,7 +968,7 @@ to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. + Call to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. ]]> @@ -1012,7 +1012,7 @@ to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. + Call to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. @@ -1067,7 +1067,7 @@ to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. + Call to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. @@ -1125,7 +1125,7 @@ to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. + Call to determine whether a format is available in this data object before calling . Call to obtain a list of all the formats that are available in this data object. @@ -1452,7 +1452,7 @@ prior to the paste operation, change, remove or add data formats, or cancel the entire copy operation by calling . + This event is intended to provide an opportunity for applications to inspect the contents of the prior to the paste operation, change, remove or add data formats, or cancel the entire copy operation by calling . ## Routed Event Information @@ -1642,7 +1642,7 @@ with `autoConvert` set to `false`). + This method adds data with auto-conversion disabled (the same as calling with `autoConvert` set to `false`). ]]> @@ -1686,7 +1686,7 @@ with `autoConvert` set to `false`). + This method adds data with auto-conversion disabled (the same as calling with `autoConvert` set to `false`). ]]> @@ -1749,7 +1749,7 @@ with `autoConvert` set to `true`). + This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). ]]> @@ -1809,7 +1809,7 @@ with `autoConvert` set to `true`). + This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). ]]> @@ -1869,7 +1869,7 @@ with `autoConvert` set to `true`). + This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). ]]> @@ -2040,7 +2040,7 @@ with `autoConvert` set to `true`). + This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). ]]> @@ -2088,7 +2088,7 @@ ## Remarks A bitmap represents a computer graphic as an array of bits in memory, and these bits represent the attributes of the individual pixels in an image. - This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). + This method adds data with auto-conversion enabled (the same as calling with `autoConvert` set to `true`). ]]> @@ -2144,7 +2144,7 @@ ## Remarks This data format denotes 16-bit character encoded Unicode, also referred to as UTF-16, and USC-2. - This method adds data with auto-conversion disabled (the same as calling with `autoConvert` set to `false`). + This method adds data with auto-conversion disabled (the same as calling with `autoConvert` set to `false`). ]]> @@ -2190,7 +2190,7 @@ with `autoConvert` set to `false`). + This method adds data with auto-conversion disabled (the same as calling with `autoConvert` set to `false`). ]]> diff --git a/xml/System.Windows/DataObjectCopyingEventHandler.xml b/xml/System.Windows/DataObjectCopyingEventHandler.xml index 7cc65b302ab..a11dff04561 100644 --- a/xml/System.Windows/DataObjectCopyingEventHandler.xml +++ b/xml/System.Windows/DataObjectCopyingEventHandler.xml @@ -32,13 +32,13 @@ The event data. Represents a method that will handle the attached event. - attached event occurs when a copy operation has finished converting the selected content into all specified data formats, has stored all data formats in the associated data object, and is ready to put the data object on the system clipboard or to begin a drag operation. - - A attached event handler method typically inspects the contents of the data object passed in as an event argument, and performs custom operations on the data object, such as adding, removing, or modifying data formats. This handler method may also cancel the copying event by calling . - + attached event occurs when a copy operation has finished converting the selected content into all specified data formats, has stored all data formats in the associated data object, and is ready to put the data object on the system clipboard or to begin a drag operation. + + A attached event handler method typically inspects the contents of the data object passed in as an event argument, and performs custom operations on the data object, such as adding, removing, or modifying data formats. This handler method may also cancel the copying event by calling . + ]]> diff --git a/xml/System.Windows/DataObjectEventArgs.xml b/xml/System.Windows/DataObjectEventArgs.xml index 95a38dbbf74..7a379da689c 100644 --- a/xml/System.Windows/DataObjectEventArgs.xml +++ b/xml/System.Windows/DataObjectEventArgs.xml @@ -101,7 +101,7 @@ method to set this property to `true` and cancel the associated command or operation. + Call the method to set this property to `true` and cancel the associated command or operation. ]]> diff --git a/xml/System.Windows/DataObjectPastingEventHandler.xml b/xml/System.Windows/DataObjectPastingEventHandler.xml index f355b6513cc..98af2020fc8 100644 --- a/xml/System.Windows/DataObjectPastingEventHandler.xml +++ b/xml/System.Windows/DataObjectPastingEventHandler.xml @@ -43,9 +43,9 @@ - Apply a custom data format to the paste selection. -- Create a new , and assign it to the property of `e`. A read-only copy of the original data object is stored in . +- Create a new , and assign it to the property of `e`. A read-only copy of the original data object is stored in . -- Cancel the paste operation by calling . +- Cancel the paste operation by calling . > [!IMPORTANT] > If the paste format is changed, the handler method is responsible for ensuring that a newly selected paste format is consumable by the paste target. diff --git a/xml/System.Windows/DataTemplate.xml b/xml/System.Windows/DataTemplate.xml index 674aaae2aae..47c03f309fb 100644 --- a/xml/System.Windows/DataTemplate.xml +++ b/xml/System.Windows/DataTemplate.xml @@ -169,7 +169,7 @@ that is in a , the is used as the key. + If you do not set the [x:Key Directive](/dotnet/framework/xaml-services/x-key-directive) on a that is in a , the is used as the key. ]]> diff --git a/xml/System.Windows/DataTrigger.xml b/xml/System.Windows/DataTrigger.xml index d8286bce292..de5a389d24e 100644 --- a/xml/System.Windows/DataTrigger.xml +++ b/xml/System.Windows/DataTrigger.xml @@ -41,16 +41,16 @@ , , and all have a triggers collection. A allows you to set property values when the property value of the data object matches a specified . For example, if you are displaying a list of `Employee` objects, you may want the foreground color to be different based on each `Employee's` current attendance. (For example, `Employees` who are currently on vacation are displayed with a purple foreground.) In some scenarios it may be more suitable to create a converter or to use a . For more information, see the [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). + , , and all have a triggers collection. A allows you to set property values when the property value of the data object matches a specified . For example, if you are displaying a list of `Employee` objects, you may want the foreground color to be different based on each `Employee's` current attendance. (For example, `Employees` who are currently on vacation are displayed with a purple foreground.) In some scenarios it may be more suitable to create a converter or to use a . For more information, see the [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). - Note that you must specify both the and properties on a for the data trigger to be meaningful. If one or both of the properties are not specified, an exception is thrown. + Note that you must specify both the and properties on a for the data trigger to be meaningful. If one or both of the properties are not specified, an exception is thrown. - The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. ## Examples - In the following example, the of the is bound to *Places*, an of *Place* objects. *Place* objects have properties *Name* and *State*. + In the following example, the of the is bound to *Places*, an of *Place* objects. *Place* objects have properties *Name* and *State*. Each of the displays a *Place* object. The in the example is applied to each . @@ -58,7 +58,7 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/Condition/Binding/Window1.xaml" id="Snippet1"::: - The following example shows how to use a , a action, and a to animate a property when bound data meets a specified condition. The example displays inventory information in a control. It uses a to animate the of every that contains an out-of-stock book. + The following example shows how to use a , a action, and a to animate a property when bound data meets a specified condition. The example displays inventory information in a control. It uses a to animate the of every that contains an out-of-stock book. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/AnimatePropertyStoryboards/XAML/DataTriggerStoryboardExample.xaml" id="Snippetgraphicsmmdatatriggerstoryboardwholepage"::: @@ -134,7 +134,7 @@ You create a binding and use the property to bind to a property of a certain object (the binding source object). For example, you may bind to the *Priority* property of a *Task*. For more information, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - Note that you must specify both the and properties on a for the data trigger to be meaningful. If one or both of the properties are not set, an exception is thrown. + Note that you must specify both the and properties on a for the data trigger to be meaningful. If one or both of the properties are not set, an exception is thrown. ## XAML Attribute Usage @@ -162,7 +162,7 @@ ## Examples - In the following example, the sets the of the element named `border` to `Yellow` if the `TaskType` property is `TaskType.Home`. + In the following example, the sets the of the element named `border` to `Yellow` if the `TaskType` property is `TaskType.Home`. :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/DataTemplatingIntro/xaml/window1.xaml" id="Snippetdt"::: :::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/DataTemplatingIntro/xaml/window1.xaml" id="Snippetdatatrigger"::: @@ -275,7 +275,7 @@ If there is more than one setter setting the same property in the same setter collection, the setter that is declared last is used. - The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. @@ -430,10 +430,10 @@ This value is compared with the property value produced by the property of the . The comparison is a reference equality check. If the two values are equal, then the associated actions or setters are applied. > [!NOTE] -> You must specify both the and properties on a for the data trigger to be meaningful. If one or both properties aren't set, an exception is thrown. +> You must specify both the and properties on a for the data trigger to be meaningful. If one or both properties aren't set, an exception is thrown. ## Examples - In the following example, the of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. + In the following example, the of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. Each of the displays a `Place` object. The in the example is applied to each . diff --git a/xml/System.Windows/DependencyObject.xml b/xml/System.Windows/DependencyObject.xml index 91c463d82e3..6dbda94ac19 100644 --- a/xml/System.Windows/DependencyObject.xml +++ b/xml/System.Windows/DependencyObject.xml @@ -43,9 +43,9 @@ services and characteristics include the following: -- Dependency property hosting support. You register a dependency property by calling the method, and storing the method's return value as a public static field in your class. +- Dependency property hosting support. You register a dependency property by calling the method, and storing the method's return value as a public static field in your class. -- Attached property hosting support. You register an attached property by calling the method, and storing the method's return value as a public static read-only field in your class. (There are also additional member requirements; note that this represents a WPF specific implementation for attached properties. For details, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview).) Your attached property can then be set on any class that derives from . +- Attached property hosting support. You register an attached property by calling the method, and storing the method's return value as a public static read-only field in your class. (There are also additional member requirements; note that this represents a WPF specific implementation for attached properties. For details, see [Attached Properties Overview](/dotnet/framework/wpf/advanced/attached-properties-overview).) Your attached property can then be set on any class that derives from . - Get, set, and clear utility methods for values of any dependency properties that exist on the . @@ -134,12 +134,12 @@ does not necessarily give a dependency property the default value that is specified in the dependency property metadata. Clearing the property only specifically clears whatever local value may have been applied. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + Clearing the property value by calling does not necessarily give a dependency property the default value that is specified in the dependency property metadata. Clearing the property only specifically clears whatever local value may have been applied. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). ## Examples - The following example iterates all properties that have local values set on an object, then calls to clear the values of each such property. + The following example iterates all properties that have local values set on an object, then calls to clear the values of each such property. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/ClearValue/Default.xaml.cs" id="Snippetiteratelocalvaluesandclear"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyObject/ClearValue/Default.xaml.vb" id="Snippetiteratelocalvaluesandclear"::: @@ -185,9 +185,9 @@ identifies a read-only dependency property for property system operations. Classes that define read-only dependency properties should not expose this key with public access. A publicly exposed key would provide a public code pathway that negated the read-only character of the property, if methods such as or could be called outside the class or assembly, referencing the key. + A identifies a read-only dependency property for property system operations. Classes that define read-only dependency properties should not expose this key with public access. A publicly exposed key would provide a public code pathway that negated the read-only character of the property, if methods such as or could be called outside the class or assembly, referencing the key. - Clearing the property value by calling does not necessarily give a dependency property the default value that is specified in the dependency property metadata. Clearing the value only specifically clears whatever local value may have been applied. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + Clearing the property value by calling does not necessarily give a dependency property the default value that is specified in the dependency property metadata. Clearing the value only specifically clears whatever local value may have been applied. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). ]]> @@ -229,16 +229,16 @@ , the for a dependency property is also invoked internally whenever the dependency property value is being re-evaluated by the WPF property system. + In addition to being explicitly invoked through calling , the for a dependency property is also invoked internally whenever the dependency property value is being re-evaluated by the WPF property system. - When you invoke the method, you are ultimately invoking the coerce value callback for the property that you specify. Typically you will invoke only if you know that a coerce value callback exists, and if you know the callback's criteria for coercion. + When you invoke the method, you are ultimately invoking the coerce value callback for the property that you specify. Typically you will invoke only if you know that a coerce value callback exists, and if you know the callback's criteria for coercion. - The most common scenario for calling is within class handling or property change callbacks of related properties that influence each other's values in a dependent way. For more information, see [Dependency Property Callbacks and Validation](/dotnet/framework/wpf/advanced/dependency-property-callbacks-and-validation). + The most common scenario for calling is within class handling or property change callbacks of related properties that influence each other's values in a dependent way. For more information, see [Dependency Property Callbacks and Validation](/dotnet/framework/wpf/advanced/dependency-property-callbacks-and-validation). ## Examples - The following example calls within a implementation that is used as the for a different dependency properties on the same class. This is a common pattern for introducing true value dependencies between dependency properties. + The following example calls within a implementation that is used as the for a different dependency properties on the same class. This is a common pattern for introducing true value dependencies between dependency properties. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/CoerceValue/class1.cs" id="Snippetonpccurrent"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/DPCallbackOverride/visualbasic/sdksamplelibrary/class1.vb" id="Snippetonpccurrent"::: @@ -280,7 +280,7 @@ and you want to perform property system specific operations on it depending on its type. For example it is more efficient to call using the rather than the CLR type. facilitates faster lookup. + This property is useful if an object that is returned from a method has a return value type of and you want to perform property system specific operations on it depending on its type. For example it is more efficient to call using the rather than the CLR type. facilitates faster lookup. @@ -413,17 +413,17 @@ , as opposed to other aspects of the property system. + A *local value* is any dependency property value that was set by , as opposed to other aspects of the property system. - The obtained by calling can be used to enumerate properties that have a locally set value on a instance. Each such property is represented in the enumerator by a object, which has properties that reference the specific and its values. This technique of enumerating over the locally set values can be used for optimization or for other handling of local values, such as to determine which property values of a would change if they were cleared. + The obtained by calling can be used to enumerate properties that have a locally set value on a instance. Each such property is represented in the enumerator by a object, which has properties that reference the specific and its values. This technique of enumerating over the locally set values can be used for optimization or for other handling of local values, such as to determine which property values of a would change if they were cleared. > [!IMPORTANT] -> The returned might contain records for dependency properties that are read-only, or dependency properties where values are calculated by the property system. For example, a visual framework element that has an established width through layout will report a local value for . If you are getting local values in order to reset them, check the value on the property identifier of each to verify that the in question is not read-only. +> The returned might contain records for dependency properties that are read-only, or dependency properties where values are calculated by the property system. For example, a visual framework element that has an established width through layout will report a local value for . If you are getting local values in order to reset them, check the value on the property identifier of each to verify that the in question is not read-only. ## Examples - The following example iterates all properties that have local values set on an object, then calls to clear the values of each such property. + The following example iterates all properties that have local values set on an object, then calls to clear the values of each such property. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/ClearValue/Default.xaml.cs" id="Snippetiteratelocalvaluesandclear"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyObject/ClearValue/Default.xaml.vb" id="Snippetiteratelocalvaluesandclear"::: @@ -471,7 +471,7 @@ This method will never return . The is a sentinel value for the property system that is used in various capacities internally and occasionally also exposed through coercion callbacks. - If you are not sure what the property's type should be, you can query the identifier of the requested dependency property to determine whether there is a more specific that the return value can be converted to. + If you are not sure what the property's type should be, you can query the identifier of the requested dependency property to determine whether there is a more specific that the return value can be converted to. ]]> @@ -513,16 +513,16 @@ , any associated and applicable or functions registered for that dependency property might be invoked. + When you call , any associated and applicable or functions registered for that dependency property might be invoked. - Calling on a property that has its local value set will have no effect, because the local value takes precedence over other property system inputs, except for animations. However, you could call , then call . For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + Calling on a property that has its local value set will have no effect, because the local value takes precedence over other property system inputs, except for animations. However, you could call , then call . For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - Calling is not necessarily applicable for many dependency property scenarios. If a dependency property becomes invalidated because of value changes in any of the constituents, the property system invalidates and re-evaluates the dependency property automatically. However, there are still some appropriate scenarios where is useful. In particular, you can use inside the coerce value or property changed callback for a different dependency property. You can also use to force re-evaluation of a binding against a data source that is not able to implement the recommended notification mechanism (perhaps if consuming data classes that cannot be derived from, or where the data is a static member). + Calling is not necessarily applicable for many dependency property scenarios. If a dependency property becomes invalidated because of value changes in any of the constituents, the property system invalidates and re-evaluates the dependency property automatically. However, there are still some appropriate scenarios where is useful. In particular, you can use inside the coerce value or property changed callback for a different dependency property. You can also use to force re-evaluation of a binding against a data source that is not able to implement the recommended notification mechanism (perhaps if consuming data classes that cannot be derived from, or where the data is a static member). ## Examples - The following example calls on a custom property, whenever properties that are involved in the invalidated property's calculations change. This is an alternative technique to calling the method, because invalidating the property will also call any registered . + The following example calls on a custom property, whenever properties that are involved in the invalidated property's calculations change. This is an alternative technique to calling the method, because invalidating the property will also call any registered . :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/InvalidateProperty/class1.cs" id="Snippetinvalidateproperty"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PropertySystemEsoterics/visualbasic/sdksamplelibrary/class1.vb" id="Snippetinvalidateproperty"::: @@ -609,9 +609,9 @@ is instead intended for modifications of the general invalidation pattern, if certain information is known about wide classifications of properties. For example, changes in a might be changes in the value types of the , or might be subproperties, where the changes are within other references. The override implementation of uses internal information to determine whether the properties are subproperties, and provides appropriate base class logic for either case. + This method is not intended to generally detect individual property changes or perform invalidations of properties on a per-case basis. is instead intended for modifications of the general invalidation pattern, if certain information is known about wide classifications of properties. For example, changes in a might be changes in the value types of the , or might be subproperties, where the changes are within other references. The override implementation of uses internal information to determine whether the properties are subproperties, and provides appropriate base class logic for either case. - is potentially invoked many times during the life of an object. Therefore, you can achieve better performance for the overall property system if you override the metadata of specific properties and then attach or functions for individual properties. However, you would use this method if a includes a significant number of value-interrelated dependency properties, or if it includes logic such as rendering behavior that must be rerun for several related cases of property invalidations. + is potentially invoked many times during the life of an object. Therefore, you can achieve better performance for the overall property system if you override the metadata of specific properties and then attach or functions for individual properties. However, you would use this method if a includes a significant number of value-interrelated dependency properties, or if it includes logic such as rendering behavior that must be rerun for several related cases of property invalidations. ]]> @@ -655,7 +655,7 @@ for most typical "get" operations for a dependency property. does not return the effective value for a variety of circumstances where the value was not locally set. + You should use for most typical "get" operations for a dependency property. does not return the effective value for a variety of circumstances where the value was not locally set. Values that are set by styles, themes, templates, the default value from metadata, or property value inheritance are not considered to be local values. However, bindings and other expressions are considered to be local values, after they have been evaluated. @@ -703,7 +703,7 @@ method changes the effective value of the property, but existing triggers, data bindings, and styles will continue to work. + This method is used by a component that programmatically sets the value of one of its own properties without disabling an application's declared use of the property. The method changes the effective value of the property, but existing triggers, data bindings, and styles will continue to work. ]]> @@ -758,7 +758,7 @@ ## Remarks If the provided type does not match the type that is declared for the dependency property as it was originally registered, an exception is thrown. The `value` parameter should always be provided as the appropriate type. - The exception conditions are potentially influenced by the callback that exists on the dependency property identifier of the dependency property being set. Otherwise, the value provided might be failing general type-checking conditions (for example, passing a string when the native type is Double). + The exception conditions are potentially influenced by the callback that exists on the dependency property identifier of the dependency property being set. Otherwise, the value provided might be failing general type-checking conditions (for example, passing a string when the native type is Double). ]]> @@ -802,9 +802,9 @@ is called only from the type that registered that dependency property, which implements the internal logic that provides the determined value for the dependency property. For more information, see [Read-Only Dependency Properties](/dotnet/framework/wpf/advanced/read-only-dependency-properties). + This signature is generally used when you set values for read-only dependency properties that are defined by your custom classes. Generally, is called only from the type that registered that dependency property, which implements the internal logic that provides the determined value for the dependency property. For more information, see [Read-Only Dependency Properties](/dotnet/framework/wpf/advanced/read-only-dependency-properties). - If the provided type does not match the type that is declared for the dependency property as it was originally registered, an exception is thrown. The `value` parameter should always be provided as the appropriate type. The exception conditions are potentially influenced by the callback that exists on the dependency property identifier of the dependency property being set. + If the provided type does not match the type that is declared for the dependency property as it was originally registered, an exception is thrown. The `value` parameter should always be provided as the appropriate type. The exception conditions are potentially influenced by the callback that exists on the dependency property identifier of the dependency property being set. diff --git a/xml/System.Windows/DependencyObjectType.xml b/xml/System.Windows/DependencyObjectType.xml index a5745c31565..d16549a0d94 100644 --- a/xml/System.Windows/DependencyObjectType.xml +++ b/xml/System.Windows/DependencyObjectType.xml @@ -29,7 +29,7 @@ ## Remarks represents a specific underlying system (CLR) of a . is essentially a wrapper for the (CLR) so that it can extend some of its capabilities. - This class has no public constructor. Instances of this class can only be obtained through properties on other objects (such as ), or through the static method . + This class has no public constructor. Instances of this class can only be obtained through properties on other objects (such as ), or through the static method . ]]> @@ -110,7 +110,7 @@ ## Examples - The following example calls , creating a based on the type of the class. + The following example calls , creating a based on the type of the class. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObjectType/FromSystemType/page3.xaml.cs" id="Snippetdotfromsystemtype"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyObjectType/FromSystemType/page3.xaml.vb" id="Snippetdotfromsystemtype"::: @@ -303,7 +303,7 @@ is the same string as the name of the type name of the . + The value of is the same string as the name of the type name of the . ]]> diff --git a/xml/System.Windows/DependencyProperty.xml b/xml/System.Windows/DependencyProperty.xml index 68703ab8c77..b9bd36bb8f0 100644 --- a/xml/System.Windows/DependencyProperty.xml +++ b/xml/System.Windows/DependencyProperty.xml @@ -85,10 +85,10 @@ ## XAML Values `dependencyPropertyName` - A string that specifies the of the desired dependency property. This can be preceded by an XML namespace prefix if the property is not in the default XML namespace (for details, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml).) + A string that specifies the of the desired dependency property. This can be preceded by an XML namespace prefix if the property is not in the default XML namespace (for details, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml).) `ownerType`.`dependencyPropertyName` - A string that specifies an owner type of a dependency property, a dot (.), then the . `ownerType` can also be preceded by an XML namespace prefix. This usage is particular to late-bound styles and templates, where the owner of the dependency property must be specified for parsing context because the `TargetType` is not yet known. For more information, see [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). + A string that specifies an owner type of a dependency property, a dot (.), then the . `ownerType` can also be preceded by an XML namespace prefix. This usage is particular to late-bound styles and templates, where the owner of the dependency property must be specified for parsing context because the `TargetType` is not yet known. For more information, see [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). `attachedPropertyOwnerType` *.* `attachedPropertyName` A string that specifies the owner of an attached property, a dot (.), then the attached property name. `attachedPropertyOwnerType` can also be preceded by an XML namespace prefix. @@ -150,13 +150,13 @@ ## Remarks This method enables the property system to recognize a dependency property on a type that did not register that particular dependency property initially. - Typically, is used to add dependency properties to classes that do not already expose that dependency property through managed class inheritance (class inheritance would cause the wrapper properties to be inherited by the derived class, and thus would provide general members-table access to the dependency property already). enables the property system to recognize a dependency property on a type that did not register that dependency property initially. + Typically, is used to add dependency properties to classes that do not already expose that dependency property through managed class inheritance (class inheritance would cause the wrapper properties to be inherited by the derived class, and thus would provide general members-table access to the dependency property already). enables the property system to recognize a dependency property on a type that did not register that dependency property initially. - This signature does not allow for specifying metadata. When you use this method, the metadata is automatically generated for the new and its owner type. The auto-generated metadata is the result of the merged metadata from all of the base types that have this property defined. If no merged metadata is available, then the default metadata for the property is used. If the property is registered by using the method, then the default metadata is the same as the metadata that is created when was called. Otherwise, the object is created with the property set to the property type's default and all other properties of the is set to `null`. Use the signature if you want to provide metadata for the version of the dependency property as added to the provided type. + This signature does not allow for specifying metadata. When you use this method, the metadata is automatically generated for the new and its owner type. The auto-generated metadata is the result of the merged metadata from all of the base types that have this property defined. If no merged metadata is available, then the default metadata for the property is used. If the property is registered by using the method, then the default metadata is the same as the metadata that is created when was called. Otherwise, the object is created with the property set to the property type's default and all other properties of the is set to `null`. Use the signature if you want to provide metadata for the version of the dependency property as added to the provided type. - The return value of this method is typically used to declare and expose the dependency property by storing a dependency property identifier. The identifier provides access to the dependency property if you want to call property system APIs against the dependency property, particularly as it exists on the adding owner class. The same property name for both original owner and added owner should be used to indicate the similar functionality. You should use the return value of the method to define the dependency property identifier, and also to declare CLR property wrappers, for dependency properties that are added to types using . + The return value of this method is typically used to declare and expose the dependency property by storing a dependency property identifier. The identifier provides access to the dependency property if you want to call property system APIs against the dependency property, particularly as it exists on the adding owner class. The same property name for both original owner and added owner should be used to indicate the similar functionality. You should use the return value of the method to define the dependency property identifier, and also to declare CLR property wrappers, for dependency properties that are added to types using . - The methodology recommended above is used when creating the dependency properties that are declared within WPF. For instance, both and define a `BorderBrush` dependency property, which have similar functionality. defines its `BorderBrush` property to the property system by calling based on the original owner and its registered dependency property identifer. The return value is then used to establish a new static field () for that property on the added owner, and a `BorderBrush` property wrapper is also declared. + The methodology recommended above is used when creating the dependency properties that are declared within WPF. For instance, both and define a `BorderBrush` dependency property, which have similar functionality. defines its `BorderBrush` property to the property system by calling based on the original owner and its registered dependency property identifer. The return value is then used to establish a new static field () for that property on the added owner, and a `BorderBrush` property wrapper is also declared. ]]> @@ -200,13 +200,13 @@ ## Remarks This method enables the property system to recognize a dependency property on a type that did not register that particular dependency property initially. - The return value of this method is used to declare and expose the dependency property, particularly as it exists on the adding owner class. Generally, the same property name for both original owner and added owner should be used to indicate the similar functionality. It is good practice to expose the identifiers, as well as new CLR property wrappers, for dependency properties that are added to types using . + The return value of this method is used to declare and expose the dependency property, particularly as it exists on the adding owner class. Generally, the same property name for both original owner and added owner should be used to indicate the similar functionality. It is good practice to expose the identifiers, as well as new CLR property wrappers, for dependency properties that are added to types using . - The methodology recommended above is used when creating APIs declared within WPF. For instance, both and define a `BorderBrush` dependency property, which have similar functionality. defines its `BorderBrush` property to the property system by calling on original owner and its registered dependency property identifer. The return value is then used to establish a static field () for that property on the added owner, and a `BorderBrush` property wrapper is also declared. + The methodology recommended above is used when creating APIs declared within WPF. For instance, both and define a `BorderBrush` dependency property, which have similar functionality. defines its `BorderBrush` property to the property system by calling on original owner and its registered dependency property identifer. The return value is then used to establish a static field () for that property on the added owner, and a `BorderBrush` property wrapper is also declared. - The added owner's dependency property identifier should be used for operations such as . However, type-specific operations involving either types or instances of the class that wer added as owner with different metadata will still return the expected results. This is true even if the original (not the added owner's) dependency property identifier is specified in calls to methods such as or . The metadata for the added owner is perpetuated by the call itself, not necessarily referenced exclusively by the adding owner class identifier field. Nevertheless, it is good practice to expose the identifier, as well as new CLR property wrappers, for dependency properties that are added to types using , because failing to do so creates disparity between the CLR and XAML representations of your properties. + The added owner's dependency property identifier should be used for operations such as . However, type-specific operations involving either types or instances of the class that wer added as owner with different metadata will still return the expected results. This is true even if the original (not the added owner's) dependency property identifier is specified in calls to methods such as or . The metadata for the added owner is perpetuated by the call itself, not necessarily referenced exclusively by the adding owner class identifier field. Nevertheless, it is good practice to expose the identifier, as well as new CLR property wrappers, for dependency properties that are added to types using , because failing to do so creates disparity between the CLR and XAML representations of your properties. - The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist. Only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics, such as , are replaced if they are specified in the new metadata. Others, such as , are combined. Ultimately, the merge behavior depends on the property metadata type being used for the override, so the behavior described here is for the existing property metadata classes used by WPF dependency properties. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). + The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist. Only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics, such as , are replaced if they are specified in the new metadata. Others, such as , are combined. Ultimately, the merge behavior depends on the property metadata type being used for the override, so the behavior described here is for the existing property metadata classes used by WPF dependency properties. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). ]]> @@ -248,17 +248,17 @@ or call. + The default metadata is the property metadata that is available to that particular object or an object of a derived type where no alternative metadata was supplied by an explicit or call. - If the original owner applied metadata to the first call that established the dependency property, then that metadata is returned as . + If the original owner applied metadata to the first call that established the dependency property, then that metadata is returned as . - If no metadata was applied in the original call, then default metadata is generated from within the call and this value is returned as the . + If no metadata was applied in the original call, then default metadata is generated from within the call and this value is returned as the . The main purpose of having default metadata associated with a is to supply a default value for this property on any or a derived type. - For nonattached properties, the metadata type returned by this property cannot be cast to derived types of type, even if the property was originally registered with a derived metadata type. If you want the originally registered metadata including its original possibly derived metadata type, call instead, passing the original registering type as a parameter. + For nonattached properties, the metadata type returned by this property cannot be cast to derived types of type, even if the property was originally registered with a derived metadata type. If you want the originally registered metadata including its original possibly derived metadata type, call instead, passing the original registering type as a parameter. - For attached properties, the type of the metadata returned by this property will match the type given in the original registration method. + For attached properties, the type of the metadata returned by this property will match the type given in the original registration method. @@ -309,7 +309,7 @@ , and the value of that property is returned by . + The property system uses its own unique identifier , and the value of that property is returned by . ]]> @@ -358,7 +358,7 @@ or calls that alter the metadata of the dependency property as it exists on a type. + Specifying either the type or an object reference to use as type is necessary because the metadata can vary from the original registration due either to or calls that alter the metadata of the dependency property as it exists on a type. @@ -406,7 +406,7 @@ or calls that can refine the property metadata as it exists on a type. + Specifying either the type or an object reference is necessary because the metadata of any given dependency property can vary from the original registration due either to or calls that can refine the property metadata as it exists on a type. When you request property metadata based on an instance, you are really just passing the instance so that its type can be evaluated internally. Dependency property metadata does not vary per instance; it is always consistent for any given type-property combination. @@ -456,7 +456,7 @@ or calls that can refine the property metadata as it exists on a type. + Specifying either the type or an object reference is necessary because the metadata of any given dependency property can vary from the original registration due either to or calls that can refine the property metadata as it exists on a type. @@ -502,7 +502,7 @@ ## Remarks This value is an integer, not a globally unique identifier (GUID). Generally, using this index value is not required, and there is no index access to tables of all dependency properties. Dependency properties should instead be referenced by their identifier fields. - is used internally for faster access to data structures that use the as a zero-based array index. A similar usage might have applications for designers or tools. + is used internally for faster access to data structures that use the as a zero-based array index. A similar usage might have applications for designers or tools. ]]> @@ -543,12 +543,12 @@ dependency property, and would return `true` for these cases. In cases where the dependency property is neither a reference nor a type, will return `false` for a null value rather than raise an exception. + A value of `null` is a valid type for reference type dependency properties, or for a dependency property, and would return `true` for these cases. In cases where the dependency property is neither a reference nor a type, will return `false` for a null value rather than raise an exception. ## Examples - The following example uses as a check before calling on the dependency property. + The following example uses as a check before calling on the dependency property. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyProperty/DefaultMetadata/XamlApp/page2.xaml.cs" id="Snippettrysetvalue"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyProperty/DefaultMetadata/page2.xaml.vb" id="Snippettrysetvalue"::: @@ -594,14 +594,14 @@ ## Remarks For a dependency property, an allowed range of values for that type can be specified through a that is provided in the dependency property registration. - This method calls internally. If the dependency property in question has no ,then calling this method is effectively equivalent to calling . If the dependency property does have a , and if would have returned `true`, then the value returned will be as implemented in the callback. + This method calls internally. If the dependency property in question has no ,then calling this method is effectively equivalent to calling . If the dependency property does have a , and if would have returned `true`, then the value returned will be as implemented in the callback. - A null value is a valid value for reference type dependency properties, or for a dependency property, and would return `true` for these cases. In cases where the dependency property is neither a reference nor a type, will return `false` for a null value rather than raise an exception. + A null value is a valid value for reference type dependency properties, or for a dependency property, and would return `true` for these cases. In cases where the dependency property is neither a reference nor a type, will return `false` for a null value rather than raise an exception. ## Examples - The following example uses as a check before calling on the dependency property. + The following example uses as a check before calling on the dependency property. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyProperty/DefaultMetadata/XamlApp/page2.xaml.cs" id="Snippettrysetvaluewithvalidate"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyProperty/DefaultMetadata/page2.xaml.vb" id="Snippettrysetvaluewithvalidate"::: @@ -649,12 +649,12 @@ This property gets the name provided as the `name` parameter during dependency property registration. This name is immutable, and cannot be `null` or an empty string. Duplicate name registrations on the same owner type are not permitted, and will throw an exception when you attempt to register the duplicate. > [!IMPORTANT] -> The of a dependency property must follow the convention of matching the name of its dependency property identifier minus the suffix "Property". For details, see [Custom Dependency Properties](/dotnet/framework/wpf/advanced/custom-dependency-properties). +> The of a dependency property must follow the convention of matching the name of its dependency property identifier minus the suffix "Property". For details, see [Custom Dependency Properties](/dotnet/framework/wpf/advanced/custom-dependency-properties). ## Examples - The following example queries various characteristics of a dependency property identifier, including the . + The following example queries various characteristics of a dependency property identifier, including the . :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyProperty/DefaultMetadata/XamlApp/page2.xaml.cs" id="Snippetdpprops"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyProperty/DefaultMetadata/page2.xaml.vb" id="Snippetdpprops"::: @@ -708,11 +708,11 @@ should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or through similar instantiation. Attempting to change metadata after instances of the owner type exist will not raise exceptions, but will result in inconsistent behaviors in the property system. + Dependency property metadata should be overridden before the property system uses the dependency property. This equates to the time that specific instances are created using the class that registers the dependency property. Calls to should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or through similar instantiation. Attempting to change metadata after instances of the owner type exist will not raise exceptions, but will result in inconsistent behaviors in the property system. After metadata for a particular derived class override is established with this method, subsequent attempts to override metadata on this same derived class will raise an exception. - The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist; only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics such as are replaced if specified in the new metadata. Others, such as , are combined. Ultimately, the merge behavior depends on the property metadata type being used for the override, so the behavior described here is for the existing property metadata classes used by WPF dependency properties. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). + The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist; only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics such as are replaced if specified in the new metadata. Others, such as , are combined. Ultimately, the merge behavior depends on the property metadata type being used for the override, so the behavior described here is for the existing property metadata classes used by WPF dependency properties. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). ]]> @@ -757,13 +757,13 @@ ) method. If overriding metadata for a read-write dependency property, use . + This signature provides underlying implementation for a read-only dependency property identifier () method. If overriding metadata for a read-write dependency property, use . - Dependency property metadata should be overridden before the property system uses the dependency property. This equates to the time that specific objects are created for the class that registers the dependency property. Calls to should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or through similar instantiation. Attempting to change metadata after instances of the owner type exist will not raise exceptions, but will result in inconsistent behaviors in the property system. + Dependency property metadata should be overridden before the property system uses the dependency property. This equates to the time that specific objects are created for the class that registers the dependency property. Calls to should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or through similar instantiation. Attempting to change metadata after instances of the owner type exist will not raise exceptions, but will result in inconsistent behaviors in the property system. After metadata for a particular derived class override is established with this method, subsequent attempts to override metadata on this same derived class will raise an exception. - The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist; only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics such as are replaced if specified in the new metadata. Others, such as , are combined. The merge behavior depends on the property metadata type being used for the override. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). + The supplied metadata is merged with the property metadata for the dependency property as it exists on the base owner. Any characteristics that were specified in the original base metadata will persist; only those characteristics that were specifically changed in the new metadata will override the characteristics of the base metadata. Some characteristics such as are replaced if specified in the new metadata. Others, such as , are combined. The merge behavior depends on the property metadata type being used for the override. For details, see [Dependency Property Metadata](/dotnet/framework/wpf/advanced/dependency-property-metadata) and [Framework Property Metadata](/dotnet/framework/wpf/advanced/framework-property-metadata). ]]> @@ -805,14 +805,14 @@ identifier generated from a call, or the type that added itself as owner in the case of a identifier generated from an call. + This value was provided during property registration. The owner will be either the original registering type in the case of a identifier generated from a call, or the type that added itself as owner in the case of a identifier generated from an call. - The on any given is immutable, and cannot be `null` in a valid . + The on any given is immutable, and cannot be `null` in a valid . ## Examples - The following example gets the owner type based on a dependency property identifier `dp`, and then gets metadata on the owner type for that same identifier. This operation is actually equivalent to getting on `dp`. + The following example gets the owner type based on a dependency property identifier `dp`, and then gets metadata on the owner type for that same identifier. This operation is actually equivalent to getting on `dp`. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyProperty/DefaultMetadata/XamlApp/page2.xaml.cs" id="Snippetdpgetmetadatasingle"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyProperty/DefaultMetadata/page2.xaml.vb" id="Snippetdpgetmetadatasingle"::: @@ -857,12 +857,12 @@ , the property type of a dependency property is immutable after registration. + This property reports the type of the property's value as declared by the original property registration, through the `propertyType` parameter. Similar to the , the property type of a dependency property is immutable after registration. ## Examples - The following example queries various characteristics of a dependency property identifier, including the . The type name string of the is obtained from the returned . + The following example queries various characteristics of a dependency property identifier, including the . The type name string of the is obtained from the returned . :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyProperty/DefaultMetadata/XamlApp/page2.xaml.cs" id="Snippetdpprops"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyProperty/DefaultMetadata/page2.xaml.vb" id="Snippetdpprops"::: @@ -902,9 +902,9 @@ method as opposed to the method. Attached properties can also be registered as read-only; see . + Read-only dependency properties are registered within the property system by calling the method as opposed to the method. Attached properties can also be registered as read-only; see . - Read-only dependency properties require a identifier rather than a identifier to perform metadata operations such as overriding the metadata or setting the value. If you obtained a collection of identifiers through a call to or another API that exposes identifiers, check the value before attempting to call or using that dependency property identifier as an input parameter, to verify that the dependency property that the identifier represents is not read-only. If the value of is `true` on a dependency property, there is no programmatic way to obtain a reference to the identifier of that dependency property, from the metadata or from the identifier; the identifier must be available as a static field in order to call against a read-only dependency property. + Read-only dependency properties require a identifier rather than a identifier to perform metadata operations such as overriding the metadata or setting the value. If you obtained a collection of identifiers through a call to or another API that exposes identifiers, check the value before attempting to call or using that dependency property identifier as an input parameter, to verify that the dependency property that the identifier represents is not read-only. If the value of is `true` on a dependency property, there is no programmatic way to obtain a reference to the identifier of that dependency property, from the metadata or from the identifier; the identifier must be available as a static field in order to call against a read-only dependency property. When you create a custom dependency property, and register it as read-only, you should define only a get accessor for the CLR wrapper property. Otherwise, your class will have a confusing object model for the property wrapper as compared to the access to the backing dependency property. For details, see [Custom Dependency Properties](/dotnet/framework/wpf/advanced/custom-dependency-properties) or [Read-Only Dependency Properties](/dotnet/framework/wpf/advanced/read-only-dependency-properties). @@ -1160,7 +1160,7 @@ ## Examples - The following example registers an attached property on an abstract class using this signature. + The following example registers an attached property on an abstract class using this signature. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/Overview/Class1.cs" id="Snippetregisterattachedbubbler2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/WPFAquariumSln/visualbasic/wpfaquariumobjects/class1.vb" id="Snippetregisterattachedbubbler2"::: @@ -1222,7 +1222,7 @@ For more information on dependency property registration, see . ## Use RegisterAttached for Value-inheriting Dependency Properties - One particular scenario for registering a dependency property with instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). + One particular scenario for registering a dependency property with instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). ]]> @@ -1277,12 +1277,12 @@ For more information on dependency property registration, see . ## Use RegisterAttached for Value-inheriting Dependency Properties - One particular scenario for registering a dependency property with instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). + One particular scenario for registering a dependency property with instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). ## Examples - The following example registers an attached property on an abstract class using this signature. This attached property is an enumeration type property, and the registration adds a validation callback to verify that the provided value is a value of the enumeration. + The following example registers an attached property on an abstract class using this signature. This attached property is an enumeration type property, and the registration adds a validation callback to verify that the provided value is a value of the enumeration. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/Overview/Class1.cs" id="Snippetregisterattachedbubbler2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/WPFAquariumSln/visualbasic/wpfaquariumobjects/class1.vb" id="Snippetregisterattachedbubbler2"::: @@ -1348,14 +1348,14 @@ , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. + This method returns the type , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. Read-only attached properties are a rare scenario, because the primary scenario for an attached property is its use in XAML. Without a public setter, an attached property cannot be set in XAML syntax. For more information on dependency property registration, see . ## Use RegisterAttached for Value-inheriting Dependency Properties - One particular scenario for registering a dependency property as attached is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). + One particular scenario for registering a dependency property as attached is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). ]]> @@ -1403,14 +1403,14 @@ , whereas returns the type . Typically, the keys that represent the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. + This method returns the type , whereas returns the type . Typically, the keys that represent the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. Read-only attached properties are a rare scenario, because the primary scenario for an attached property is its use in XAML. Without a public setter, an attached property cannot be set in XAML syntax. For more information on dependency property registration, see . ## Use RegisterAttached for Value-inheriting Dependency Properties - One particular scenario for registering a dependency property as attached instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). + One particular scenario for registering a dependency property as attached instead of is to support property value inheritance. You should register value-inheriting dependency properties with even if the class defines property wrapper accessors that expose the dependency property, and even if you do not intend to expose Get* and Set* static methods to provide true attached property support accessors. Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Registering the property as attached effectively makes the attached property a global property to the property system, and assures that property value inheritance works across all boundaries in an element tree. Always use to register properties where you specify in the metadata. For more information, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). ]]> @@ -1471,7 +1471,7 @@ , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. + This method returns the type , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. Read-only dependency properties are a fairly typical scenario both in the existing API and for customization scenarios, because other WPF features might require a dependency property even if that property is not intended to be settable by callers. You can use the value of a read-only dependency property as the basis for other property system operations that take a dependency property, such as basing a on the dependency property in a style. @@ -1531,7 +1531,7 @@ , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. + This method returns the type , whereas returns the type . Typically, the keys that represent read-only properties are not made public, because the keys can be used to set the dependency property value by calling . Your class design will affect your requirements, but it is generally recommended to limit the access and visibility of any to only those parts of your code that are necessary to set that dependency property as part of class or application logic. It is also recommended that you expose a dependency property identifier for the read-only dependency property, by exposing the value of as a `public static readonly` field on your class. Read-only dependency properties are a fairly typical scenario. You can use the value of a read-only dependency property as the basis for other property system operations that take a dependency property, such as basing a on the dependency property in a style. @@ -1610,17 +1610,17 @@ is a sentinel value that is used for scenarios where the WPF property system is unable to determine a requested value. is used rather than `null`, because `null` could be a valid property value, as well as a valid (and frequently used) . + is a sentinel value that is used for scenarios where the WPF property system is unable to determine a requested value. is used rather than `null`, because `null` could be a valid property value, as well as a valid (and frequently used) . - is never returned out of . When you call on a dependency property on a instance, one of the following applies: + is never returned out of . When you call on a dependency property on a instance, one of the following applies: -- A dependency property has a default value established in metadata and that value is returned. This value might come from . +- A dependency property has a default value established in metadata and that value is returned. This value might come from . - Some other value was established by the property system, and the default value is no longer relevant. For details, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - Setting a of is specifically disallowed. + Setting a of is specifically disallowed. - returns when the requested property has not been locally set. + returns when the requested property has not been locally set. has a special meaning when used as the return value of a . For details, see [Dependency Property Callbacks and Validation](/dotnet/framework/wpf/advanced/dependency-property-callbacks-and-validation). diff --git a/xml/System.Windows/DependencyPropertyChangedEventArgs.xml b/xml/System.Windows/DependencyPropertyChangedEventArgs.xml index 43cb14e3234..85951915d3c 100644 --- a/xml/System.Windows/DependencyPropertyChangedEventArgs.xml +++ b/xml/System.Windows/DependencyPropertyChangedEventArgs.xml @@ -24,21 +24,21 @@ Provides data for various property changed events. Typically these events report effective value changes in the value of a read-only dependency property. Another usage is as part of a implementation. - class for event data, and the method implementations for handlers, generally follow the naming pattern `Is*Changed`, and are generally implemented as common language runtime (CLR) events without backing (they are not routed events). Some class handling methods that "handle" otherwise unexposed events that report a state change through a property change, such as , also use the class for event data. - - The scenario for is to use the arguments to report old and new values that come from the property system evaluation of the property. A callback that processes old and new values might choose special handling depending on these values, such as choosing to not respond to value changes that are deemed insignificant. - - - -## Examples - The following example uses the class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. - + class for event data, and the method implementations for handlers, generally follow the naming pattern `Is*Changed`, and are generally implemented as common language runtime (CLR) events without backing (they are not routed events). Some class handling methods that "handle" otherwise unexposed events that report a state change through a property change, such as , also use the class for event data. + + The scenario for is to use the arguments to report old and new values that come from the property system evaluation of the property. A callback that processes old and new values might choose special handling depending on these values, such as choosing to not respond to value changes that are deemed insignificant. + + + +## Examples + The following example uses the class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyPropertyChangedEventArgs/Overview/NumericUpDown.cs" id="Snippetdependencypropertychangedeventargs"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: + ]]> @@ -75,11 +75,11 @@ The value of the property after the change reported by the relevant event or state change. Initializes a new instance of the class. - @@ -125,11 +125,11 @@ if the provided object is equivalent to the current ; otherwise, . - @@ -166,11 +166,11 @@ if the provided is equivalent to the current ; otherwise, . - @@ -232,19 +232,19 @@ Gets the value of the property after the change. The property value after the change. - class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. - + class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyPropertyChangedEventArgs/Overview/NumericUpDown.cs" id="Snippetdependencypropertychangedeventargs"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: + ]]> @@ -276,19 +276,19 @@ Gets the value of the property before the change. The property value before the change. - class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. - + class in the context of a for a particular property of a custom class that also defines events. The callback takes the results of old and new values from the property system as communicated by , and repackages these into a different events arguments class . The new arguments are then used as the data for a "ValueChanged" event defined by and raised by the custom class. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyPropertyChangedEventArgs/Overview/NumericUpDown.cs" id="Snippetdependencypropertychangedeventargs"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/DependencyPropertyChangedEventArgs/Overview/numericupdown.vb" id="Snippetdependencypropertychangedeventargs"::: + ]]> @@ -327,11 +327,11 @@ if the two instances are equivalent; otherwise, . - . - + . + ]]> @@ -370,11 +370,11 @@ if the two instances are different; otherwise, . - . - + . + ]]> @@ -412,11 +412,11 @@ Gets the identifier for the dependency property where the value change occurred. The identifier field of the dependency property where the value change occurred. - that is registered for several properties, and it is necessary to disambiguate which property change invoked the callback. is not typically relevant for raising events, because there is usually a 1:1 correspondence between properties and events that report the property change. The event that was raised is itself the indication of which property changed. - + that is registered for several properties, and it is necessary to disambiguate which property change invoked the callback. is not typically relevant for raising events, because there is usually a 1:1 correspondence between properties and events that report the property change. The event that was raised is itself the indication of which property changed. + ]]> diff --git a/xml/System.Windows/DependencyPropertyChangedEventHandler.xml b/xml/System.Windows/DependencyPropertyChangedEventHandler.xml index a0e4f8c80cc..13165e70af9 100644 --- a/xml/System.Windows/DependencyPropertyChangedEventHandler.xml +++ b/xml/System.Windows/DependencyPropertyChangedEventHandler.xml @@ -32,15 +32,15 @@ The event data. Represents the method that will handle events raised when a is changed on a particular implementation. - of the property that changed. The arguments of the event are used to query the old and new value of the property, as reported by the particular event. Typically there is a 1:1 correspondence between properties that change and a particular event that reports the change. It is also possible, though uncommon, to have the same event report changes to more than one property. In this case, the should be checked to determine the property that changed. - - The event data class has a wider usage than just this delegate. is also used to communicate data for implementations, which are part of the customization features and internals of the WPF property system, and by the virtual method, which can be overridden to provide class-specific notifications whenever any dependency property on the object changes. - + of the property that changed. The arguments of the event are used to query the old and new value of the property, as reported by the particular event. Typically there is a 1:1 correspondence between properties that change and a particular event that reports the change. It is also possible, though uncommon, to have the same event report changes to more than one property. In this case, the should be checked to determine the property that changed. + + The event data class has a wider usage than just this delegate. is also used to communicate data for implementations, which are part of the customization features and internals of the WPF property system, and by the virtual method, which can be overridden to provide class-specific notifications whenever any dependency property on the object changes. + ]]> diff --git a/xml/System.Windows/DependencyPropertyHelper.xml b/xml/System.Windows/DependencyPropertyHelper.xml index fc45e0cf258..8ec8211c0cd 100644 --- a/xml/System.Windows/DependencyPropertyHelper.xml +++ b/xml/System.Windows/DependencyPropertyHelper.xml @@ -24,13 +24,13 @@ Provides a single helper method () that reports the property system source for the effective value of a dependency property. - at run-time on that property. If the value came from a different source than you had intended, you might need to adjust some aspect of your application. The value source might be a style, a theme, a local value, an animation, a binding, or a run-time based value such as system settings through themes or system resources. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - - Another mechanism that reports on the property in general, rather than a specific instance of the property on an object, is the property metadata. The property metadata is findable by calling and examining the returned (or one of several possible derived classes that the returned property metadata is castable to). - + at run-time on that property. If the value came from a different source than you had intended, you might need to adjust some aspect of your application. The value source might be a style, a theme, a local value, an animation, a binding, or a run-time based value such as system settings through themes or system resources. For more information, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + + Another mechanism that reports on the property in general, rather than a specific instance of the property on an object, is the property metadata. The property metadata is findable by calling and examining the returned (or one of several possible derived classes that the returned property metadata is castable to). + ]]> @@ -68,11 +68,11 @@ Returns a structure that reports various metadata and property system characteristics of a specified dependency property on a particular . A structure that reports the specific information. - @@ -111,9 +111,9 @@ if belongs to an instance of a template that defines a value for the specified property that may change at runtime based on changes elsewhere; otherwise, . - , and objects. This method provides more detailed information in cases where the value of the property is . diff --git a/xml/System.Windows/DependencyPropertyKey.xml b/xml/System.Windows/DependencyPropertyKey.xml index 22e3b530566..9677cf85fd7 100644 --- a/xml/System.Windows/DependencyPropertyKey.xml +++ b/xml/System.Windows/DependencyPropertyKey.xml @@ -27,13 +27,13 @@ instances are obtained as the return value of a dependency property registration call using the methods or . + instances are obtained as the return value of a dependency property registration call using the methods or . - The types that register a dependency property can use the in calls to and that adjust the property's value as part of class logic. If permitted by the access level of the key, related classes can use the key and the dependency property also. For instance, you can declare the key as internal, and other types within the same assembly can also set that dependency property. + The types that register a dependency property can use the in calls to and that adjust the property's value as part of class logic. If permitted by the access level of the key, related classes can use the key and the dependency property also. For instance, you can declare the key as internal, and other types within the same assembly can also set that dependency property. The returned by read-only dependency property registration should not be made public, because exposing the key makes the property settable, thus defeating the point of registering it as a read-only dependency property. Also, exposing the key causes a mismatch between the available dependency property behaviors and its common language runtime (CLR) property wrapper implementations, which is bad class design. - Instead of exposing the key itself, you should instead expose the value of the as a `public static readonly` on your class. This enables the property to return a valid dependency property identifier for certain property system operations such as enumerating locally set values. However, the identifier thus obtained does not have the full capabilities of a for many property system operations. + Instead of exposing the key itself, you should instead expose the value of the as a `public static readonly` on your class. This enables the property to return a valid dependency property identifier for certain property system operations such as enumerating locally set values. However, the identifier thus obtained does not have the full capabilities of a for many property system operations. @@ -84,20 +84,20 @@ value enables a read-only property's identifier to participate in common property system operations using some of the same interfaces as used for read-write dependency properties. + The value enables a read-only property's identifier to participate in common property system operations using some of the same interfaces as used for read-write dependency properties. In order to implement the get property accessor for a read-only dependency property, you should create and expose a identifier on your class. This serves two purposes: -- Your own class needs the identifier in order to implement the get accessor for the property wrapper. You use the as a parameter for the call that implements the get accessor. +- Your own class needs the identifier in order to implement the get accessor for the property wrapper. You use the as a parameter for the call that implements the get accessor. -- identifiers expose your dependency property to the property system such that other methods that rely on metadata can access it in a standard form. For instance, if you called on some and obtained an enumeration of locally set properties (values and identifiers) the identifier returned for a read-only dependency property would be your value rather than the key. Not exposing a identifier does not increase the security of your read-only dependency property in any way, it just makes operations that involve your property more awkward both for subsequent derived classes and class instances. +- identifiers expose your dependency property to the property system such that other methods that rely on metadata can access it in a standard form. For instance, if you called on some and obtained an enumeration of locally set properties (values and identifiers) the identifier returned for a read-only dependency property would be your value rather than the key. Not exposing a identifier does not increase the security of your read-only dependency property in any way, it just makes operations that involve your property more awkward both for subsequent derived classes and class instances. - To expose the identifier on your class, you call directly on your key. Use this value to create a `public static readonly` identifier on the class, which parallels the . + To expose the identifier on your class, you call directly on your key. Use this value to create a `public static readonly` identifier on the class, which parallels the . ## Examples - The following example calls to expose the identifier (`AquariumGraphicProperty`) for the `AquariumGraphic` read-only dependency property on a class. The example also shows the creation (as an internal member) and the get accessor for `AquariumGraphic`. + The following example calls to expose the identifier (`AquariumGraphicProperty`) for the `AquariumGraphic` read-only dependency property on a class. The example also shows the creation (as an internal member) and the get accessor for `AquariumGraphic`. :::code language="csharp" source="~/snippets/csharp/System.Windows/DependencyObject/Overview/Class1.cs" id="Snippetrodp"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/WPFAquariumSln/visualbasic/wpfaquariumobjects/class1.vb" id="Snippetrodp"::: @@ -144,9 +144,9 @@ ## Remarks Overriding metadata on a read-only dependency property is done for similar reasons as overriding metadata on a read-write dependency property, and is restricted to access at the key level because behaviors specified in the metadata can change the set behavior (the default value, for instance). - As with read-write dependency properties, overriding metadata on a read-only dependency property should only be done prior to that property being placed in use by the property system (this equates to the time that specific instances of objects that register the property are instantiated). Calls to should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or equivalent initialization for that class. + As with read-write dependency properties, overriding metadata on a read-only dependency property should only be done prior to that property being placed in use by the property system (this equates to the time that specific instances of objects that register the property are instantiated). Calls to should only be performed within the static constructors of the type that provides itself as the `forType` parameter of this method, or equivalent initialization for that class. - This method effectively forwards to the method, passing the instance as the key parameter. + This method effectively forwards to the method, passing the instance as the key parameter. diff --git a/xml/System.Windows/DpiScale.xml b/xml/System.Windows/DpiScale.xml index 0cd302ee378..bfa7392b3c6 100644 --- a/xml/System.Windows/DpiScale.xml +++ b/xml/System.Windows/DpiScale.xml @@ -81,11 +81,11 @@ Gets the DPI scale on the X axis. The DPI scale for the X axis. - @@ -116,11 +116,11 @@ Gets the DPI scale on the Yaxis. The DPI scale for the Y axis. - @@ -179,11 +179,11 @@ Gets the DPI along X axis. The DPI along the X axis. - and reference the number of pixels that are drawn within an inch on the screen. - + and reference the number of pixels that are drawn within an inch on the screen. + ]]> @@ -214,11 +214,11 @@ Gets the DPI along Y axis. The DPI along the Y axis. - and reference the number of pixels that are drawn within an inch on the screen. - + and reference the number of pixels that are drawn within an inch on the screen. + ]]> diff --git a/xml/System.Windows/DragDrop.xml b/xml/System.Windows/DragDrop.xml index 5b984799a2d..b174c24b516 100644 --- a/xml/System.Windows/DragDrop.xml +++ b/xml/System.Windows/DragDrop.xml @@ -32,7 +32,7 @@ > [!NOTE] > The and classes contain aliases for the drag-and-drop events so that the events appear in the class members list when these classes are inherited as a base class. When you attach an event handler to a drag-and-drop event on one of these classes, the handler is attached to the underlying event and they receive the same instance of event data. For example, see . - The drag source initiates a drag-and-drop operation by calling the static method and passing the transferred data to it. An element typically handles the following events when it is a drag source: + The drag source initiates a drag-and-drop operation by calling the static method and passing the transferred data to it. An element typically handles the following events when it is a drag source: - @@ -92,7 +92,7 @@ ## Remarks The event occurs when an object is dragged into the element's bounds. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -137,7 +137,7 @@ ## Remarks The event occurs when an object is dragged out of the element's bounds. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -182,7 +182,7 @@ ## Remarks The event occurs when an object is dragged over the element's bounds. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -227,7 +227,7 @@ ## Remarks The event occurs when an object is dropped within an element's bounds. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -272,7 +272,7 @@ ## Remarks The event occurs during a drag operation. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -317,7 +317,7 @@ ## Remarks The event occurs when an object is dragged into the element's bounds. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -362,7 +362,7 @@ ## Remarks The event occurs when an object is dragged out of the element's bounds. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -407,7 +407,7 @@ ## Remarks The event occurs when n object is dragged over the element's bounds. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -452,7 +452,7 @@ ## Remarks The event occurs when an object is dropped within an element's bounds. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -497,7 +497,7 @@ ## Remarks The event occurs during a drag operation. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -542,7 +542,7 @@ ## Remarks The event occurs during a drag-and-drop operation, and enables the drag source to determine whether the drag-and-drop operation should be canceled. - This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . + This method adds a handler for the tunneling version of the event. To add a handler for the bubbling version of this event, see . ]]> @@ -587,7 +587,7 @@ ## Remarks The event occurs during a drag-and-drop operation, and enables the drag source to determine whether the drag-and-drop operation should be canceled. - This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . + This method adds a handler for the bubbling version of the event. To add a handler for the tunneling version of this event, see . ]]> @@ -639,14 +639,14 @@ and sequence of events occurs over the element to be dragged. You initiate the drag-and-drop operation by calling the static method and passing the transferred data to it. The method will automatically wrap the data in a if necessary. For greater control over the data format, you can wrap the data in a before passing it to the method. + It is the responsibility of your application to determine when a drag occurs, and then initiate the drag-and-drop operation. Typically, this is when a and sequence of events occurs over the element to be dragged. You initiate the drag-and-drop operation by calling the static method and passing the transferred data to it. The method will automatically wrap the data in a if necessary. For greater control over the data format, you can wrap the data in a before passing it to the method. - The value returned from the method is the value of the property set in the drop target's event handler. If the return value does not match one of the `allowedEffects` specified in the call to , the drag-and-drop operation is not performed. + The value returned from the method is the value of the property set in the drop target's event handler. If the return value does not match one of the `allowedEffects` specified in the call to , the drag-and-drop operation is not performed. ## Examples - The following example shows how to initiate a drag-and-drop operation from the event handler of an element to make it a drag source. The transferred data is the string representation of the ellipse's property. The data is passed to the method as a string and is automatically wrapped in a . + The following example shows how to initiate a drag-and-drop operation from the event handler of an element to make it a drag source. The transferred data is the string representation of the ellipse's property. The data is passed to the method as a string and is automatically wrapped in a . :::code language="csharp" source="~/snippets/csharp/System.Windows/DragDrop/DoDragDrop/mainwindow.xaml.cs" id="Snippetdodragdrop"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DragDrop/DoDragDrop/mainwindow.xaml.vb" id="Snippetdodragdrop"::: @@ -699,7 +699,7 @@ ## Examples - The following example shows the event handler for an element. This code previews the effects of the drag-and-drop operation by saving the current brush. It then checks to see if the being dragged over the ellipse contains string data that can be converted to a . If so, the is applied to the ellipse. The change is reverted in the event handler. If the data cannot be converted to a , no action is performed. + The following example shows the event handler for an element. This code previews the effects of the drag-and-drop operation by saving the current brush. It then checks to see if the being dragged over the ellipse contains string data that can be converted to a . If so, the is applied to the ellipse. The change is reverted in the event handler. If the data cannot be converted to a , no action is performed. :::code language="csharp" source="~/snippets/csharp/System.Windows/DragDrop/DoDragDrop/mainwindow.xaml.cs" id="Snippetdragenter"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/DragDrop/DoDragDrop/mainwindow.xaml.vb" id="Snippetdragenter"::: @@ -969,7 +969,7 @@ ## Remarks The event is raised once when an object is dropped within the bounds of an element that is acting as a drop target. This event is not raised if the element's property is `false`. This event ends the drag-and-drop operation. - In the event handler, you extract the transferred data from the and perform any processing of the data that your application requires. To notify the drag source of the effect of the drop, such as a copy or move, set the property in the event handler. The value of this property is the return value of the method that initiated the drag-and-drop operation. If the value that is returned does not match one of the `allowedEffects` specified in the call to , the drag-and-drop operation is not performed. The initial value of the property is the same as the `allowedEffects` specified in the call to the method. If you do not set the property, this initial value is returned and it is assumed that one the `allowedEffects` occurred. + In the event handler, you extract the transferred data from the and perform any processing of the data that your application requires. To notify the drag source of the effect of the drop, such as a copy or move, set the property in the event handler. The value of this property is the return value of the method that initiated the drag-and-drop operation. If the value that is returned does not match one of the `allowedEffects` specified in the call to , the drag-and-drop operation is not performed. The initial value of the property is the same as the `allowedEffects` specified in the call to the method. If you do not set the property, this initial value is returned and it is assumed that one the `allowedEffects` occurred. ## Routed Event Information @@ -1668,7 +1668,7 @@ event is raised continuously while the drag source is being dragged. You can handle this event to determine what action ends the drag-and-drop operation based on the state of the ESC, SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons. The default handler for this event cancels the drag-and-drop operation if the ESC key is pressed, and drops the data if the mouse button is released. If you handle this event to change the default behavior, be sure to provide an equivalent mechanism in your handler to end the drag-and-drop operation. Otherwise, the method will not return and your application will stop responding. If you handle this event, you must mark it as handled to prevent the default behavior from overriding your handler. + The event is raised continuously while the drag source is being dragged. You can handle this event to determine what action ends the drag-and-drop operation based on the state of the ESC, SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons. The default handler for this event cancels the drag-and-drop operation if the ESC key is pressed, and drops the data if the mouse button is released. If you handle this event to change the default behavior, be sure to provide an equivalent mechanism in your handler to end the drag-and-drop operation. Otherwise, the method will not return and your application will stop responding. If you handle this event, you must mark it as handled to prevent the default behavior from overriding your handler. ## Routed Event Information @@ -1765,7 +1765,7 @@ ## Remarks The event occurs when an object is dragged into the element's bounds. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> @@ -1810,7 +1810,7 @@ ## Remarks The event occurs when an object is dragged out of the element's bounds. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> @@ -1855,7 +1855,7 @@ ## Remarks The event occurs when an object is dragged over the element's bounds. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> @@ -1900,7 +1900,7 @@ ## Remarks The event occurs when an object is dropped within an element's bounds. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> @@ -1945,7 +1945,7 @@ ## Remarks The event occurs during a drag operation. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> @@ -1990,7 +1990,7 @@ ## Remarks The event occurs when an object is dragged into the element's bounds. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2035,7 +2035,7 @@ ## Remarks The event occurs when an object is dragged out of the element's bounds. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2080,7 +2080,7 @@ ## Remarks The event occurs when n object is dragged over the element's bounds. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2125,7 +2125,7 @@ ## Remarks The event occurs when an object is dropped within an element's bounds. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2170,7 +2170,7 @@ ## Remarks The event occurs during a drag operation. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2215,7 +2215,7 @@ ## Remarks The event occurs during a drag-and-drop operation, and enables the drag source to determine whether the drag-and-drop operation should be canceled. - This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . + This method removes a handler for the tunneling version of the event. To remove a handler for the bubbling version of this event, see . ]]> @@ -2260,7 +2260,7 @@ ## Remarks The event occurs during a drag-and-drop operation, and enables the drag source to determine whether the drag-and-drop operation should be canceled. - This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . + This method removes a handler for the bubbling version of the event. To remove a handler for the tunneling version of this event, see . ]]> diff --git a/xml/System.Windows/DragEventArgs.xml b/xml/System.Windows/DragEventArgs.xml index 29d4abdc7b9..3f30f148558 100644 --- a/xml/System.Windows/DragEventArgs.xml +++ b/xml/System.Windows/DragEventArgs.xml @@ -59,11 +59,11 @@ Gets a member of the enumeration that specifies which operations are allowed by the originator of the drag event. A member of the enumeration that specifies which operations are allowed by the originator of the drag event. - method, permissible operations are specified with a member of the enumeration. For example, when dragging a read-only file the drag initiator should indicate that the file can be copied, but not moved. Before attempting to perform an operation on dragged data, examine this property to ensure that the operation is allowed. - + method, permissible operations are specified with a member of the enumeration. For example, when dragging a read-only file the drag initiator should indicate that the file can be copied, but not moved. Before attempting to perform an operation on dragged data, examine this property to ensure that the operation is allowed. + ]]> @@ -136,11 +136,11 @@ Gets or sets the target drag-and-drop operation. A member of the enumeration specifying the target drag-and-drop operation. - @@ -248,11 +248,11 @@ Gets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons. One or more members of the flag enumeration. - diff --git a/xml/System.Windows/Duration.xml b/xml/System.Windows/Duration.xml index c593af0e947..f54b924d1ba 100644 --- a/xml/System.Windows/Duration.xml +++ b/xml/System.Windows/Duration.xml @@ -49,11 +49,11 @@ -or- - \<*object* *property*=""/> + \<*object* *property*=""/> -or- - \<*object* *property*=""/> + \<*object* *property*=""/> ## XAML Values @@ -233,7 +233,7 @@ instances with a property value of are a special case with the following return values. + instances with a property value of are a special case with the following return values. - If `t1` is Automatic and `t2` is not, -1 is returned. @@ -499,7 +499,7 @@ If either or has no value, this method returns . - ]]> + ]]> @@ -537,7 +537,7 @@ if both instances of have values and are equal, or if both instances of are . Otherwise, this method returns . - ]]> + ]]> @@ -578,9 +578,9 @@ is considered greater than any finite value. Any comparison with an value returns `false`. + is considered greater than any finite value. Any comparison with an value returns `false`. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -621,9 +621,9 @@ is considered greater than any finite value. Any comparison with an value returns `false`. + is considered greater than any finite value. Any comparison with an value returns `false`. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -659,7 +659,7 @@ Implicitly creates a from a given . A new instance of . - ]]> + ]]> Occurs when is negative. @@ -698,7 +698,7 @@ if exactly one of or represent a value, or if they both represent values that are not equal; otherwise, . - ]]> + ]]> @@ -739,9 +739,9 @@ is considered greater than any finite value. Any comparison with an value returns `false`. + is considered greater than any finite value. Any comparison with an value returns `false`. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -782,9 +782,9 @@ is considered greater than any finite value. Any comparison with an value returns `false`. + is considered greater than any finite value. Any comparison with an value returns `false`. - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -824,23 +824,23 @@ . + The following calculations all return a value of . -- minus . +- minus . -- minus . +- minus . -- minus . +- minus . -- minus . +- minus . -- minus . +- minus . -- minus . +- minus . -- minus . +- minus . - The equivalent method for this operator is ]]> + The equivalent method for this operator is ]]> @@ -875,7 +875,7 @@ Returns the specified instance of . An instance of . - ]]> + ]]> diff --git a/xml/System.Windows/DynamicResourceExtensionConverter.xml b/xml/System.Windows/DynamicResourceExtensionConverter.xml index eb6d8459f91..960abe37339 100644 --- a/xml/System.Windows/DynamicResourceExtensionConverter.xml +++ b/xml/System.Windows/DynamicResourceExtensionConverter.xml @@ -24,11 +24,11 @@ Converts from parsed XAML to and supports dynamic resource references made from XAML. - @@ -145,11 +145,11 @@ Converts the specified object to another type. The returned converted object. Cast this to the requested type. Ordinarily this should be cast to . - ; if not, then the implementation falls through to base (, which may throw an exception). - + ; if not, then the implementation falls through to base (, which may throw an exception). + ]]> diff --git a/xml/System.Windows/EventManager.xml b/xml/System.Windows/EventManager.xml index 924b8878c40..50391318312 100644 --- a/xml/System.Windows/EventManager.xml +++ b/xml/System.Windows/EventManager.xml @@ -24,21 +24,21 @@ Provides event-related utility methods that register routed events for class owners and add class handlers. - . - - The second most common API usage is . You use this method to enable class handling of a routed event on the class, or an attached event. For details, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - - - -## Examples - The following example show how to use this class to register a new routed event as a class member, along with the routed event "wrapper" technique of overriding the add and remove implementations for a CLR event. - + . + + The second most common API usage is . You use this method to enable class handling of a routed event on the class, or an attached event. For details, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). + + + +## Examples + The following example show how to use this class to register a new routed event as a class member, along with the routed event "wrapper" technique of overriding the add and remove implementations for a CLR event. + :::code language="csharp" source="~/snippets/csharp/System.Windows/CoerceValueCallback/Overview/default.xaml.cs" id="Snippeteventmanagerclass"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/CoerceValueCallback/Overview/default.xaml.vb" id="Snippeteventmanagerclass"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/CoerceValueCallback/Overview/default.xaml.vb" id="Snippeteventmanagerclass"::: + ]]> @@ -71,11 +71,11 @@ Returns identifiers for routed events that have been registered to the event system. An array of type that contains the registered objects. - objects can be registered later. This method gets a snapshot and the collection of routed events is writeable throughout an application's lifetime. The collection returned might be quite large. Even just counting the events that are part of the WPF APIs, the collection count is in the high hundreds. - + objects can be registered later. This method gets a snapshot and the collection of routed events is writeable throughout an application's lifetime. The collection returned might be quite large. Even just counting the events that are part of the WPF APIs, the collection count is in the high hundreds. + ]]> @@ -162,27 +162,27 @@ A reference to the class handler implementation. Registers a class handler for a particular routed event. - in static constructors. These class handling methods typically exist for input events and have names that start with "On" and end with the name of the event being class handled. - - For more information about class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - - Using this signature, class handlers will be registered to invoke only in response to unhandled events. You can also register class handlers to invoke even if the event arguments are marked handled, by using the signature, with `handledEventsToo` set to `true`. - - - -## Examples - The following example adds a handler for , calling . - + in static constructors. These class handling methods typically exist for input events and have names that start with "On" and end with the name of the event being class handled. + + For more information about class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). + + Using this signature, class handlers will be registered to invoke only in response to unhandled events. You can also register class handlers to invoke even if the event arguments are marked handled, by using the signature, with `handledEventsToo` set to `true`. + + + +## Examples + The following example adds a handler for , calling . + :::code language="csharp" source="~/snippets/csharp/System.Windows/EventManager/RegisterClassHandler/class1.cs" id="Snippetstaticandregisterclasshandler"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ClassHandling/visualbasic/sdksamplelibrary/class1.vb" id="Snippetstaticandregisterclasshandler"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ClassHandling/visualbasic/sdksamplelibrary/class1.vb" id="Snippetstaticandregisterclasshandler"::: + ]]> @@ -224,19 +224,19 @@ to invoke this class handler even if arguments of the routed event have been marked as handled; to retain the default behavior of not invoking the handler on any marked-handled event. Registers a class handler for a particular routed event, with the option to handle events where event data is already marked handled. - in static constructors. These class handling methods typically exist for input events and have names that start with "On" and end with the name of the event being class handled. - - For more information about class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - - Using this signature, class handlers can be registered to invoke upon handled events, by setting `handledEventsToo` set to `true`. Generally, you should do this only if there is a known handling issue you are trying to work around, such as input system handling from mouse or keyboard events. - + in static constructors. These class handling methods typically exist for input events and have names that start with "On" and end with the name of the event being class handled. + + For more information about class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). + + Using this signature, class handlers can be registered to invoke upon handled events, by setting `handledEventsToo` set to `true`. Generally, you should do this only if there is a known handling issue you are trying to work around, such as input system handling from mouse or keyboard events. + ]]> @@ -278,13 +278,13 @@ Registers a new routed event with the Windows Presentation Foundation (WPF) event system. The identifier for the newly registered routed event. This identifier object can now be stored as a static field in a class and then used as a parameter for methods that attach handlers to the event. The routed event identifier is also used for other event system APIs. - identifier field. This field should be stored within the owner type. - - There are a considerable number of conventions and best practices associated with how routed events should be named, registered, and exposed in a class. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + identifier field. This field should be stored within the owner type. + + There are a considerable number of conventions and best practices associated with how routed events should be named, registered, and exposed in a class. For more information, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> diff --git a/xml/System.Windows/EventSetter.xml b/xml/System.Windows/EventSetter.xml index 7c0786324b3..82963ccbee1 100644 --- a/xml/System.Windows/EventSetter.xml +++ b/xml/System.Windows/EventSetter.xml @@ -27,7 +27,7 @@ rather than requiring you to attach instance handlers to each individual element. Only support objects. + Event setters invoke the specified event handlers in response to routed events, which apply to all elements that reference the rather than requiring you to attach instance handlers to each individual element. Only support objects. You can only declare event setters for events that are routed events. You can declare event setters for routed events with a direct routing strategy, bubbling events, or tunneling events. @@ -35,11 +35,11 @@ Event setters cannot be used in a style that is contained in a theme resource dictionary. This is because a theme resource dictionary at run time is often loose binary XAML (BAML) files, and does not have any scope defined where accompanying code-behind that defines the handlers can exist. - Handlers attached through event setters are invoked after any class handlers for an event, and also after any instance handlers. As a result, if a class handler or instance handler marks an event handled in its arguments, then the handler declared by an event setter is not invoked, unless the event setter specifically sets `true`. + Handlers attached through event setters are invoked after any class handlers for an event, and also after any instance handlers. As a result, if a class handler or instance handler marks an event handled in its arguments, then the handler declared by an event setter is not invoked, unless the event setter specifically sets `true`. - Event setters may also come from styles. The event setter handlers from the style specified as will be invoked after the handlers on the immediate style. + Event setters may also come from styles. The event setter handlers from the style specified as will be invoked after the handlers on the immediate style. - Note that only supports objects. Triggers ( and derived classes) do not support . + Note that only supports objects. Triggers ( and derived classes) do not support . @@ -173,7 +173,7 @@ is in use and thus is sealed. If you set this property in code and there is the possibility that the style is in use, check the value of the property on the instance before you attempt to set . + You cannot set this property once the style containing the is in use and thus is sealed. If you set this property in code and there is the possibility that the style is in use, check the value of the property on the instance before you attempt to set . @@ -232,7 +232,7 @@ ## Remarks > [!IMPORTANT] -> Setting the characteristics of how an event's handlers will be invoked must always be performed in code, in keeping with the general principle that there is no way to specify when assigning defined event handlers for instances directly to named events in XAML attribute syntax. Although setting this value in XAML does not generate any compile-time errors, the resulting XAML will produce a run-time exception when the style is used. +> Setting the characteristics of how an event's handlers will be invoked must always be performed in code, in keeping with the general principle that there is no way to specify when assigning defined event handlers for instances directly to named events in XAML attribute syntax. Although setting this value in XAML does not generate any compile-time errors, the resulting XAML will produce a run-time exception when the style is used. ## XAML Text Usage diff --git a/xml/System.Windows/EventTrigger.xml b/xml/System.Windows/EventTrigger.xml index 3d5aabedfb8..4deabab8ad6 100644 --- a/xml/System.Windows/EventTrigger.xml +++ b/xml/System.Windows/EventTrigger.xml @@ -37,16 +37,16 @@ objects have the , , and properties that apply changes or actions based on the state of certain properties, while objects start a set of when a specified routed event occurs. For example, you may want to use an to start a set of animations when the mouse pointer is over a certain user interface (UI) control. Unlike , has no concept of termination of state, so the action will not be undone once the condition that raised the event is no longer true. + objects have the , , and properties that apply changes or actions based on the state of certain properties, while objects start a set of when a specified routed event occurs. For example, you may want to use an to start a set of animations when the mouse pointer is over a certain user interface (UI) control. Unlike , has no concept of termination of state, so the action will not be undone once the condition that raised the event is no longer true. - Note that when using an , you need to choose events that do not interfere with the inherent behavior of your control. Controls such as or perform specific actions on user input events such as mouse clicks and keyboard events. For example, if you are styling a button and try to set the event as the of an , the never gets applied because the event first gets handled by the button. Instead, you can use the event or a different event. + Note that when using an , you need to choose events that do not interfere with the inherent behavior of your control. Controls such as or perform specific actions on user input events such as mouse clicks and keyboard events. For example, if you are styling a button and try to set the event as the of an , the never gets applied because the event first gets handled by the button. Instead, you can use the event or a different event. - When using data binding, if you are using the event, you must set the value of your object to `true` for the event to be raised. + When using data binding, if you are using the event, you must set the value of your object to `true` for the event to be raised. Adding a child to an object implicitly adds it to the for the object. ## Examples - This example shows how to use event triggers in a style to animate the and events of a . In this example, the has the set to . Therefore, there is no need to qualify the `MouseEnter` and `MouseLeave` event names with the class name. + This example shows how to use event triggers in a style to animate the and events of a . In this example, the has the set to . Therefore, there is no need to qualify the `MouseEnter` and `MouseLeave` event names with the class name. :::code language="xaml" source="~/snippets/csharp/System.Windows/EventTrigger/Overview/Default.xaml" id="Snippeteventtriggersnippet"::: @@ -298,12 +298,12 @@ If the template or style that contains this does not have the `TargetType` property specified, then you need to quality the event name with the class name using the `ClassName.EventName` syntax. - objects cannot handle events that have already been . Controls such as or perform specific actions on user input events such as mouse clicks and keyboard events. For example, if you are styling a button and try to set the event as the of an , the never gets applied because the event first gets handled by the button. Instead, you can use the event or a different event. + objects cannot handle events that have already been . Controls such as or perform specific actions on user input events such as mouse clicks and keyboard events. For example, if you are styling a button and try to set the event as the of an , the never gets applied because the event first gets handled by the button. Instead, you can use the event or a different event. - When using data binding, if you are using the event, you must set the value of your object to true for the event to be raised. + When using data binding, if you are using the event, you must set the value of your object to true for the event to be raised. ## Examples - This example shows how to use event triggers in a style to animate the and events of a . In this example, the has the set to . Therefore, there is no need to qualify the `MouseEnter` and `MouseLeave` event names with the class name. + This example shows how to use event triggers in a style to animate the and events of a . In this example, the has the set to . Therefore, there is no need to qualify the `MouseEnter` and `MouseLeave` event names with the class name. :::code language="xaml" source="~/snippets/csharp/System.Windows/EventTrigger/Overview/Default.xaml" id="Snippeteventtriggersnippet"::: diff --git a/xml/System.Windows/ExitEventArgs.xml b/xml/System.Windows/ExitEventArgs.xml index 8e6389db2b1..0c73b60eaab 100644 --- a/xml/System.Windows/ExitEventArgs.xml +++ b/xml/System.Windows/ExitEventArgs.xml @@ -69,10 +69,10 @@ ## Remarks An application typically returns an exit code to the operating system to indicate whether an application exited successfully or not. An application exit code value of **0** (the default) is commonly used to indicate success. However, you are free to return exit code values that are appropriate to your application. - You can specify an exit code by handling the event and setting with an appropriate value. + You can specify an exit code by handling the event and setting with an appropriate value. > [!NOTE] -> You can also specify an exit code by calling method. If you do, the value of is the value of the exit code that you pass to . +> You can also specify an exit code by calling method. If you do, the value of is the value of the exit code that you pass to . ]]> diff --git a/xml/System.Windows/ExpressionConverter.xml b/xml/System.Windows/ExpressionConverter.xml index 35466a67bce..080a23d9237 100644 --- a/xml/System.Windows/ExpressionConverter.xml +++ b/xml/System.Windows/ExpressionConverter.xml @@ -24,11 +24,11 @@ Converts instances of to and from other types. - type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, and always return `false`. and always throw an exception. - + type should not use a type converter pathway to convert values (should use markup extensions instead). For this reason, and always return `false`. and always throw an exception. + ]]> diff --git a/xml/System.Windows/FigureHorizontalAnchor.xml b/xml/System.Windows/FigureHorizontalAnchor.xml index fbe41616916..5eafb11f55f 100644 --- a/xml/System.Windows/FigureHorizontalAnchor.xml +++ b/xml/System.Windows/FigureHorizontalAnchor.xml @@ -26,7 +26,7 @@ attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: diff --git a/xml/System.Windows/FigureLength.xml b/xml/System.Windows/FigureLength.xml index 2ba9b3b5e80..c9b20caa85b 100644 --- a/xml/System.Windows/FigureLength.xml +++ b/xml/System.Windows/FigureLength.xml @@ -70,11 +70,11 @@ ## Examples - In the following example, when the user clicks on the , the of the decreases. Below is the XAML for the sample. + In the following example, when the user clicks on the , the of the decreases. Below is the XAML for the sample. :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: - Below is the code used to decrease the of the . + Below is the code used to decrease the of the . :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: @@ -127,11 +127,11 @@ , the of the decreases. Below is the XAML for the sample. + In the following example, when the user clicks on the , the of the decreases. Below is the XAML for the sample. :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: - Below is the code used to decrease the of the . + Below is the code used to decrease the of the . :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: @@ -171,11 +171,11 @@ , the of the decreases. Below is the XAML for the sample. + In the following example, when the user clicks on the , the of the decreases. Below is the XAML for the sample. :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: - Below is the code used to decrease the of the . + Below is the code used to decrease the of the . :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: @@ -194,7 +194,7 @@ structures must be exactly the same in every way, not just have the same . + The two structures must be exactly the same in every way, not just have the same . ]]> @@ -309,7 +309,7 @@ ## Remarks The value that goes along with this unit type can be found using the property. - This property is read-only. To set the value of this property, use the constructor. + This property is read-only. To set the value of this property, use the constructor. ]]> @@ -528,7 +528,7 @@ if and are equal; otherwise, . - . ]]> + . ]]> @@ -566,7 +566,7 @@ if and are not equal; otherwise, . - . ]]> + . ]]> @@ -632,7 +632,7 @@ ## Remarks The unit type of this value can be found using the property. - This property is read-only. To set the value of this property, use the or constructor. + This property is read-only. To set the value of this property, use the or constructor. ]]> diff --git a/xml/System.Windows/FigureUnitType.xml b/xml/System.Windows/FigureUnitType.xml index f364284cdc0..00d6f6fc3aa 100644 --- a/xml/System.Windows/FigureUnitType.xml +++ b/xml/System.Windows/FigureUnitType.xml @@ -26,11 +26,11 @@ , the of the decreases. Below is the XAML for the sample. + In the following example, when the user clicks on the , the of the decreases. Below is the XAML for the sample. :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml" id="Snippetfigurelengthexamplewholepage"::: - Below is the code used to decrease the of the using the Pixel to specify the unit type. + Below is the code used to decrease the of the using the Pixel to specify the unit type. :::code language="csharp" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/figurelengthexample.xaml.cs" id="Snippetfigurelengthcodebehindexamplewholepage"::: diff --git a/xml/System.Windows/FigureVerticalAnchor.xml b/xml/System.Windows/FigureVerticalAnchor.xml index 49803d71f84..4ee51aa8d8e 100644 --- a/xml/System.Windows/FigureVerticalAnchor.xml +++ b/xml/System.Windows/FigureVerticalAnchor.xml @@ -31,7 +31,7 @@ ## Examples - The following example shows how to set the attribute of a element. + The following example shows how to set the attribute of a element. :::code language="xaml" source="~/snippets/csharp/System.Windows/FigureHorizontalAnchor/Overview/Window1.xaml" id="Snippet_figurepropsxaml"::: diff --git a/xml/System.Windows/FlowDirection.xml b/xml/System.Windows/FlowDirection.xml index 925f6779490..6f63e4be0e9 100644 --- a/xml/System.Windows/FlowDirection.xml +++ b/xml/System.Windows/FlowDirection.xml @@ -29,23 +29,23 @@ Defines constants that specify the content flow direction for text and user interface (UI) elements. - enumeration to set the attribute of a flow content element (). - - :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_flowdirectionxaml"::: - - The following example shows how to use the enumeration programmatically. - + enumeration to set the attribute of a flow content element (). + + :::code language="xaml" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml" id="Snippet_block_flowdirectionxaml"::: + + The following example shows how to use the enumeration programmatically. + :::code language="csharp" source="~/snippets/csharp/System.Windows/FlowDirection/Overview/Window1.xaml.cs" id="Snippet_block_flowdirection"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/FlowDirection/Overview/window1.xaml.vb" id="Snippet_block_flowdirection"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/FlowDirection/Overview/window1.xaml.vb" id="Snippet_block_flowdirection"::: + ]]> diff --git a/xml/System.Windows/FontStretch.xml b/xml/System.Windows/FontStretch.xml index eab5e9ac3e0..50d4e42a28f 100644 --- a/xml/System.Windows/FontStretch.xml +++ b/xml/System.Windows/FontStretch.xml @@ -47,15 +47,15 @@ |Font stretch|usWidthClass|% of normal| |------------------|------------------|-----------------| -||1|50.0%| -||2|62.5%| -||3|75.0%| -||4|87.5%| -||5|100.0%| -||6|112.5%| -||7|125.0%| -||8|150.0%| -||9|200.0%| +||1|50.0%| +||2|62.5%| +||3|75.0%| +||4|87.5%| +||5|100.0%| +||6|112.5%| +||7|125.0%| +||8|150.0%| +||9|200.0%| For more information on the OpenType `usWidthClass` value, see the [usWidthClass](https://learn.microsoft.com/typography/opentype/spec/os2#uswidthclass) section of the OpenType specification. diff --git a/xml/System.Windows/FontStretches.xml b/xml/System.Windows/FontStretches.xml index 2be20f75e17..5c64f1dd1e8 100644 --- a/xml/System.Windows/FontStretches.xml +++ b/xml/System.Windows/FontStretches.xml @@ -24,28 +24,28 @@ Provides a set of static predefined values. - values correspond to the `usWidthClass` definition in the OpenType specification. The `usWidthClass` represents an integer value between 1 and 9. Lower numeric values indicate narrower widths; higher values indicate wider widths. - -|Font stretch|usWidthClass|% of normal| -|------------------|------------------|-----------------| -||1|50%| -||2|62.5%| -||3|75%| -||4|87.5%| -||5|100%| -||5|100%| -||6|112.5%| -||7|125%| -||8|150%| -||9|200%| - + values correspond to the `usWidthClass` definition in the OpenType specification. The `usWidthClass` represents an integer value between 1 and 9. Lower numeric values indicate narrower widths; higher values indicate wider widths. + +|Font stretch|usWidthClass|% of normal| +|------------------|------------------|-----------------| +||1|50%| +||2|62.5%| +||3|75%| +||4|87.5%| +||5|100%| +||5|100%| +||6|112.5%| +||7|125%| +||8|150%| +||9|200%| + For more information on the OpenType `usWidthClass` value, see the [usWidthClass](https://learn.microsoft.com/typography/opentype/spec/os2#uswidthclass) section of the OpenType specification. - + ]]> @@ -77,11 +77,11 @@ Specifies a condensed . A value that represents a condensed . - represents 75% of the normal aspect ratio of the font form. - + represents 75% of the normal aspect ratio of the font form. + ]]> @@ -113,11 +113,11 @@ Specifies an expanded . A value that represents an expanded . - represents 125% of the normal aspect ratio of the font form. - + represents 125% of the normal aspect ratio of the font form. + ]]> @@ -149,11 +149,11 @@ Specifies an extra-condensed . A value that represents an extra-condensed . - represents 62.5% of the normal aspect ratio of the font form. - + represents 62.5% of the normal aspect ratio of the font form. + ]]> @@ -185,11 +185,11 @@ Specifies an extra-expanded . A value that represents an extra-expanded . - represents 150% of the normal aspect ratio of the font form. - + represents 150% of the normal aspect ratio of the font form. + ]]> @@ -221,11 +221,11 @@ Specifies a medium . A value that represents a medium . - represents the normal (100%) aspect ratio of the font form. The value of is equivalent to the value of . - + represents the normal (100%) aspect ratio of the font form. The value of is equivalent to the value of . + ]]> @@ -257,11 +257,11 @@ Specifies a normal . A value that represents a normal . - represents the normal (100%) aspect ratio of the font form. The value of is equivalent to the value of . - + represents the normal (100%) aspect ratio of the font form. The value of is equivalent to the value of . + ]]> @@ -293,11 +293,11 @@ Specifies a semi-condensed . A value that represents a semi-condensed . - represents 87.5% of the normal aspect ratio of the font form. - + represents 87.5% of the normal aspect ratio of the font form. + ]]> @@ -329,11 +329,11 @@ Specifies a semi-expanded . A value that represents a semi-expanded . - represents 112.5% of the normal aspect ratio of the font form. - + represents 112.5% of the normal aspect ratio of the font form. + ]]> @@ -365,11 +365,11 @@ Specifies an ultra-condensed . A value that represents an ultra-condensed . - represents 50% of the normal aspect ratio of the font form. - + represents 50% of the normal aspect ratio of the font form. + ]]> @@ -401,11 +401,11 @@ Specifies an ultra-expanded . A value that represents an ultra-expanded . - represents 200% of the normal aspect ratio of the font form. - + represents 200% of the normal aspect ratio of the font form. + ]]> diff --git a/xml/System.Windows/FontStyles.xml b/xml/System.Windows/FontStyles.xml index 98e1e5bc9d4..0347a6ef058 100644 --- a/xml/System.Windows/FontStyles.xml +++ b/xml/System.Windows/FontStyles.xml @@ -35,7 +35,7 @@ |Italic|The characters in an italic font are truly slanted and appear as they were designed.| |Oblique|The characters in an oblique font are artificially slanted| - For , the slant is achieved by performing a shear transformation on the characters from a normal font. When a true italic font is not available on a computer or printer, an oblique style can be generated from the normal font and used to simulate an italic font. + For , the slant is achieved by performing a shear transformation on the characters from a normal font. When a true italic font is not available on a computer or printer, an oblique style can be generated from the normal font and used to simulate an italic font. The following illustration shows the normal, italic, and oblique font styles for the Palatino Linotype font. Notice how the italic font style has a more flowing and visually appealing appearance than the oblique font style, which is simply created by skewing the normal font style version of the text. @@ -45,7 +45,7 @@ Example of font styles ## Examples - In the following code example, , , and are used to define the font styles for the objects. + In the following code example, , , and are used to define the font styles for the objects. :::code language="xaml" source="~/snippets/csharp/System.Windows/FontStyle/Overview/FontStyleSnippets.xaml" id="Snippetfontstylesnippet1"::: diff --git a/xml/System.Windows/FontWeight.xml b/xml/System.Windows/FontWeight.xml index 0039771b32d..70a0fff40a1 100644 --- a/xml/System.Windows/FontWeight.xml +++ b/xml/System.Windows/FontWeight.xml @@ -113,7 +113,7 @@ ## Examples - In the following code example, the method is used to evaluate two objects. + In the following code example, the method is used to evaluate two objects. :::code language="csharp" source="~/snippets/csharp/System.Windows/FontStyle/Overview/Window1.xaml.cs" id="Snippetfontsnippet11"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FontStyles/Italic/window1.xaml.vb" id="Snippetfontsnippet11"::: diff --git a/xml/System.Windows/FontWeights.xml b/xml/System.Windows/FontWeights.xml index 788faa1a832..597b3316bf0 100644 --- a/xml/System.Windows/FontWeights.xml +++ b/xml/System.Windows/FontWeights.xml @@ -24,35 +24,35 @@ Provides a set of static predefined values. - values correspond to the `usWeightClass` definition in the OpenType specification. The `usWeightClass` represents an integer value between 1 and 999. Lower values indicate lighter weights; higher values indicate heavier weights. - -|Font weight|usWeightClass| -|-----------------|-------------------| -||100| -|

|200| -||300| -|

|400| -||500| -|

|600| -||700| -|

|800| -|

|900| -|

|950| - - For more information about the OpenType 'usWeightClass' value, see the [usWeightClass](https://learn.microsoft.com/typography/opentype/spec/os2#usweightclass) section of the OpenType specification. - - - -## Examples - In the following code example, the is set to "UltraBold". - - :::code language="xaml" source="~/snippets/csharp/System.Windows/FontStyle/Overview/Window1.xaml" id="Snippetfontsnippet12"::: - + values correspond to the `usWeightClass` definition in the OpenType specification. The `usWeightClass` represents an integer value between 1 and 999. Lower values indicate lighter weights; higher values indicate heavier weights. + +|Font weight|usWeightClass| +|-----------------|-------------------| +||100| +|

|200| +||300| +|

|400| +||500| +|

|600| +||700| +|

|800| +|

|900| +|

|950| + + For more information about the OpenType 'usWeightClass' value, see the [usWeightClass](https://learn.microsoft.com/typography/opentype/spec/os2#usweightclass) section of the OpenType specification. + + + +## Examples + In the following code example, the is set to "UltraBold". + + :::code language="xaml" source="~/snippets/csharp/System.Windows/FontStyle/Overview/Window1.xaml" id="Snippetfontsnippet12"::: + ]]> @@ -86,11 +86,11 @@ Specifies a "Black" font weight. A value that represents a "Black" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -151,11 +151,11 @@ Specifies a "Demi-bold" font weight. A value that represents a "Demi-bold" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -187,11 +187,11 @@ Specifies an "Extra-black" font weight. A value that represents an "Extra-black" font weight. - font weight is the heaviest font weight. is equivalent in font weight to . - + font weight is the heaviest font weight. is equivalent in font weight to . + ]]> @@ -223,11 +223,11 @@ Specifies an "Extra-bold" font weight. A value that represents an "Extra-bold" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -259,11 +259,11 @@ Specifies an "Extra-light" font weight. A value that represents an "Extra-light" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -295,11 +295,11 @@ Specifies a "Heavy" font weight. A value that represents a "Heavy" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -389,16 +389,16 @@ Specifies a "Normal" font weight. A value that represents a "Normal" font weight. - is equivalent in font weight to . - - - -## Examples - An "Ultra-bold" font weight describes a heavier stroke than a normal weight. - + is equivalent in font weight to . + + + +## Examples + An "Ultra-bold" font weight describes a heavier stroke than a normal weight. + ]]> @@ -430,11 +430,11 @@ Specifies a "Regular" font weight. A value that represents a "Regular" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -466,11 +466,11 @@ Specifies a "Semi-bold" font weight. A value that represents a "Semi-bold" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> @@ -502,11 +502,11 @@ Specifies a "Thin" font weight. A value that represents a "Thin" font weight. - font weight is the lightest font weight. - + font weight is the lightest font weight. + ]]> @@ -538,11 +538,11 @@ Specifies an "Ultra-black" font weight. A value that represents an "Ultra-black" font weight. - font weight is the heaviest font weight. is equivalent in font weight to . - + font weight is the heaviest font weight. is equivalent in font weight to . + ]]> @@ -574,16 +574,16 @@ Specifies an "Ultra-bold" font weight. A value that represents an "Ultra-bold" font weight. - is equivalent in font weight to . - - - -## Examples - An "Ultra-bold" font weight describes a heavier stroke than a normal weight. - + is equivalent in font weight to . + + + +## Examples + An "Ultra-bold" font weight describes a heavier stroke than a normal weight. + ]]> @@ -615,11 +615,11 @@ Specifies an "Ultra-light" font weight. A value that represents an "Ultra-light" font weight. - is equivalent in font weight to . - + is equivalent in font weight to . + ]]> diff --git a/xml/System.Windows/FrameworkCompatibilityPreferences.xml b/xml/System.Windows/FrameworkCompatibilityPreferences.xml index 887812d425c..a97c3f5ed04 100644 --- a/xml/System.Windows/FrameworkCompatibilityPreferences.xml +++ b/xml/System.Windows/FrameworkCompatibilityPreferences.xml @@ -53,11 +53,11 @@ if the application should use the and properties for the colors of inactive selected items; otherwise, - @@ -89,11 +89,11 @@ if a data-bound should display a string that is identical to the value of the source its property; otherwise, . - @@ -125,15 +125,15 @@ if a failed copy or cut operation in a instance results in a ; otherwise, . - (which is a type of ExternalException) is thrown. - - Because the Win32 `OpenClipboard` API acts globally, well-written applications should call the corresponding `CloseClipboard` API as soon as they have completed their clipboard operations. Otherwise, other applications running in the same session will be unable to access clipboard functions. - - In WPF, such a denial of access to the clipboard is normally ignored silently. However, applications can opt to receive an `ExternalException` upon failure by setting the flag to `true`. However, opting to receive exceptions also requires the application to handle and RoutedUICommands through a , and then apply that binding to all TextBoxBase controls ( and ) in the application. The application should ensure that it handles ExternalExceptions resulting from copy and cut operations in the CommandBinding's Executed handler. - + (which is a type of ExternalException) is thrown. + + Because the Win32 `OpenClipboard` API acts globally, well-written applications should call the corresponding `CloseClipboard` API as soon as they have completed their clipboard operations. Otherwise, other applications running in the same session will be unable to access clipboard functions. + + In WPF, such a denial of access to the clipboard is normally ignored silently. However, applications can opt to receive an `ExternalException` upon failure by setting the flag to `true`. However, opting to receive exceptions also requires the application to handle and RoutedUICommands through a , and then apply that binding to all TextBoxBase controls ( and ) in the application. The application should ensure that it handles ExternalExceptions resulting from copy and cut operations in the CommandBinding's Executed handler. + ]]> diff --git a/xml/System.Windows/FrameworkContentElement.xml b/xml/System.Windows/FrameworkContentElement.xml index eed2f23140e..01ed0d86301 100644 --- a/xml/System.Windows/FrameworkContentElement.xml +++ b/xml/System.Windows/FrameworkContentElement.xml @@ -138,9 +138,9 @@ ## Remarks This method can throw an exception if called at a time when the logical tree is being iterated by another process. - Most derived classes expose dedicated collections that are responsible for containment (for example, on the class; on the class). You can typically avoid any need to manipulate the logical tree directly if you derive from these classes instead. Working with the logical tree for content elements is an advanced scenario that may require a specialized parser or a specialized that acts as the parent rendering element (content host). + Most derived classes expose dedicated collections that are responsible for containment (for example, on the class; on the class). You can typically avoid any need to manipulate the logical tree directly if you derive from these classes instead. Working with the logical tree for content elements is an advanced scenario that may require a specialized parser or a specialized that acts as the parent rendering element (content host). - For more information about how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + For more information about how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). ]]> @@ -290,9 +290,9 @@ To avoid performance issues when you apply a large number of clocks by using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -346,9 +346,9 @@ To avoid performance issues when you apply a large number of clocks by using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -408,7 +408,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -472,7 +472,7 @@ on any parent scrollable area that contains the element (the parent may very well be a , not a ). If this element is not contained in a scrollable area, the event is still raised, but there will be no effect. + By calling this method, you effectively will call on any parent scrollable area that contains the element (the parent may very well be a , not a ). If this element is not contained in a scrollable area, the event is still raised, but there will be no effect. ]]> @@ -619,7 +619,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> @@ -706,7 +706,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> @@ -778,7 +778,7 @@ The `null` default really means that determination of the practical cursor value is deferred here and should be obtained from elsewhere. If presented with no programmatic values from any source, the default cursor over a Windows Presentation Foundation (WPF) application will be an arrow. - Each movement of the mouse over a WPF application raises a event. The event bubbles, and any element along the route has the opportunity to handle the event and to set the value of the cursor via the arguments of this event. If that happens, the fact that the event is handled and has a changed value in the arguments takes precedence over the value of the property at any level, unless is set. + Each movement of the mouse over a WPF application raises a event. The event bubbles, and any element along the route has the opportunity to handle the event and to set the value of the cursor via the arguments of this event. If that happens, the fact that the event is handled and has a changed value in the arguments takes precedence over the value of the property at any level, unless is set. If not creating a custom cursor, typically you set this property to a static property value of the class. @@ -879,11 +879,11 @@ Data context can be set directly to a common language runtime (CLR) object, with the bindings evaluating to properties of that object. Alternatively, you can set the data context to a object. - This dependency property inherits property values. If there are child elements with no other value for established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. + This dependency property inherits property values. If there are child elements with no other value for established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. - Alternatively, you can use one of the following properties of the class to specify the binding source explicitly: , , or . For more information, see [How to: Specify the Binding Source](/dotnet/framework/wpf/data/how-to-specify-the-binding-source). + Alternatively, you can use one of the following properties of the class to specify the binding source explicitly: , , or . For more information, see [How to: Specify the Binding Source](/dotnet/framework/wpf/data/how-to-specify-the-binding-source). - In XAML, is most commonly set to as a declaration. You can use either property element syntax or attribute syntax. Attribute syntax is shown in the example on this page. You can also set in code. + In XAML, is most commonly set to as a declaration. You can use either property element syntax or attribute syntax. Attribute syntax is shown in the example on this page. You can also set in code. ## XAML Property Element Usage @@ -929,12 +929,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example sets a binding on a element, by creating a new custom data object, establishing that object as , and setting the binding path to a property within it. + The following example sets a binding on a element, by creating a new custom data object, establishing that object as , and setting the binding path to a property within it. :::code language="csharp" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml.cs" id="Snippetdatacontext"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/ContentElement/CaptureMouse/page1.xaml.vb" id="Snippetdatacontext"::: @@ -975,7 +975,7 @@ For an explanation of data contexts and data binding, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). > [!IMPORTANT] -> When an element's changes, all data-bound properties on this element are potentially affected. This applies to any elements that are descendant elements of the current element, which inherit the data context, and also the current element itself. All such bindings re-interpret the new to reflect the new value in bindings. There is no guarantee made about the order of these changes relative to the raising of the event. The changes can occur before the event, after the event, or in any mixture. +> When an element's changes, all data-bound properties on this element are potentially affected. This applies to any elements that are descendant elements of the current element, which inherit the data context, and also the current element itself. All such bindings re-interpret the new to reflect the new value in bindings. There is no guarantee made about the order of these changes relative to the raising of the event. The changes can occur before the event, after the event, or in any mixture. ]]> @@ -1039,9 +1039,9 @@ method against the identifier, within the static constructor of the control subclass. + This property is typically not set through any of its direct setters. Instead, you override the type-specific metadata of this dependency property every time you create a new subclass. When you subclass, call the method against the identifier, within the static constructor of the control subclass. - For instance, an inline class such as actually has very little implementation beyond overriding the metadata in its static constructor, and exposing several instance constructors. The fact that elements surrounded by the tag gain a property of is implemented within the theme style that was referenced by setting the default value of to `typeof(Bold)`. + For instance, an inline class such as actually has very little implementation beyond overriding the metadata in its static constructor, and exposing several instance constructors. The fact that elements surrounded by the tag gain a property of is implemented within the theme style that was referenced by setting the default value of to `typeof(Bold)`. If you want your element or control to deliberately not use theme styles, set the property to `true`. @@ -1051,7 +1051,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1122,7 +1122,7 @@ Your implementation should call the base implementation, because the base (default) implementation sets some internal flags to keep track of initialization. - If was previously called, the base implementation will raise the event. Otherwise, if was not called or it could not be determined whether was called, the event is not raised. + If was previously called, the base implementation will raise the event. Otherwise, if was not called or it could not be determined whether was called, the event is not raised. ]]> @@ -1212,7 +1212,7 @@ ## Remarks > [!IMPORTANT] -> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions for this case, you should instead call . returns `null` when no resource is found, and does not throw an exception. +> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions for this case, you should instead call . returns `null` when no resource is found, and does not throw an exception. If the resource is not found on the calling element, the parent tree is searched using the logical tree, in the same way that the tree would be searched if a resource were requested by key at run-time. @@ -1267,7 +1267,7 @@ Note that this property affects visual appearance but does not report so in metadata. This is because the visual appearance change is event-driven and may not apply at all times, and thus should not generally report any visual or layout information in metadata. - Conceptually, the visual behavior of focus applied to a control should be coherent from element to element. The most sensible way to enforce coherence is to only change the focus visual style if you are composing an entire theme. Setting this property on individual styles and not as part of a theme is not the intended usage of this property, because it may lead to a confusing user experience regarding keyboard focus. If you are intending element-specific behavior that is deliberately not coherent across a theme, a much better approach is to use triggers in styles for individual input state properties, such as or , and to do so in a way that does not visually interfere with any existing focus visual style. For more information on the design intention of and alternative focus properties, see [Styling for Focus in Controls, and FocusVisualStyle](/dotnet/framework/wpf/advanced/styling-for-focus-in-controls-and-focusvisualstyle). + Conceptually, the visual behavior of focus applied to a control should be coherent from element to element. The most sensible way to enforce coherence is to only change the focus visual style if you are composing an entire theme. Setting this property on individual styles and not as part of a theme is not the intended usage of this property, because it may lead to a confusing user experience regarding keyboard focus. If you are intending element-specific behavior that is deliberately not coherent across a theme, a much better approach is to use triggers in styles for individual input state properties, such as or , and to do so in a way that does not visually interfere with any existing focus visual style. For more information on the design intention of and alternative focus properties, see [Styling for Focus in Controls, and FocusVisualStyle](/dotnet/framework/wpf/advanced/styling-for-focus-in-controls-and-focusvisualstyle). ## XAML Attribute Usage @@ -1361,7 +1361,7 @@ is more appropriate in control subclassing or compositing scenarios. + Setting this property to `true` will override the cursor preferences established by child elements. Doing so in general application UI might be confusing for the user, particularly if child elements are attempting to specify cursors. Setting is more appropriate in control subclassing or compositing scenarios. ## Dependency Property Information @@ -1525,7 +1525,7 @@ or methods are called. Calls to these methods could have been made by deliberate code, or by the Extensible Application Markup Language (XAML) loading process. + This event will be raised whenever the or methods are called. Calls to these methods could have been made by deliberate code, or by the Extensible Application Markup Language (XAML) loading process. ]]> @@ -1561,7 +1561,7 @@ established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. + This dependency property inherits property values. If there are child elements with no other value for established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. Although a XAML syntax usage is listed and is syntactically allowed, setting this property in XAML is not common. @@ -1571,7 +1571,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1689,7 +1689,7 @@ ## Examples - The following example code uses as a conditional check to assure that a function `displayData` (not shown) will have valid elements loaded on the page to work against, as part of an on-demand handler. That same logic is run as an event handler for . + The following example code uses as a conditional check to assure that a function `displayData` (not shown) will have valid elements loaded on the page to work against, as part of an on-demand handler. That same logic is run as an event handler for . :::code language="csharp" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml.cs" id="Snippetisloaded"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/ContentElement/CaptureMouse/page1.xaml.vb" id="Snippetisloaded"::: @@ -1731,7 +1731,7 @@ ## Remarks The string formats follow the RFC 3066 standard. For example, U.S. English is "en-US". See for more information on the values and format. - This dependency property inherits property values. If there are child elements with no other value for established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. + This dependency property inherits property values. If there are child elements with no other value for established through local values or styles, the property system will set the value to be the value of the nearest parent element with this value assigned. ## Dependency Property Information @@ -1739,7 +1739,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -1846,7 +1846,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> @@ -1882,7 +1882,7 @@ and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + For more information on how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). ]]> @@ -1969,13 +1969,13 @@ This property essentially provides a WPF framework-level convenience property to set the XAML [x:Name Directive](/dotnet/framework/xaml-services/x-name-directive). - Getting a from code is not common, because if you have the appropriate reference in code already, you can just call methods and properties on the element reference and do not generally need the . An exception is if the string has some overloaded meaning, for instance if it is useful to display that name in UI. Setting a from code if the original was set from markup is also not recommended, and changing the property will not change the object reference. Such object references are created only when the underlying namescopes are explicitly created during XAML loading. + Getting a from code is not common, because if you have the appropriate reference in code already, you can just call methods and properties on the element reference and do not generally need the . An exception is if the string has some overloaded meaning, for instance if it is useful to display that name in UI. Setting a from code if the original was set from markup is also not recommended, and changing the property will not change the object reference. Such object references are created only when the underlying namescopes are explicitly created during XAML loading. - You must specifically call to make an effective change on the property of an already loaded element. + You must specifically call to make an effective change on the property of an already loaded element. - One notable case where setting from code is important is for naming elements that storyboards will run against. Before you can register a name, might also need to instantiate and assign a instance. See the Example section, or [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). + One notable case where setting from code is important is for naming elements that storyboards will run against. Before you can register a name, might also need to instantiate and assign a instance. See the Example section, or [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). - Setting from code has limited applications, but looking up an element by name is more common, particularly if you are employing a navigation model where pages reload into the application and the run-time code is not necessarily the code-behind of that respective page. The utility method , which is available from any , can find any element by in that element's logical tree recursively. Or you can use the static method of , which also takes the string as an argument. + Setting from code has limited applications, but looking up an element by name is more common, particularly if you are employing a navigation model where pages reload into the application and the run-time code is not necessarily the code-behind of that respective page. The utility method , which is available from any , can find any element by in that element's logical tree recursively. Or you can use the static method of , which also takes the string as an argument. Commonly used root elements (, for example) implement the interface . Implementations of this interface are expected to enforce that names be unambiguous within their scope. @@ -1985,7 +1985,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2404,7 +2404,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2479,16 +2479,16 @@ See [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf) for more information about traversing logical trees, and the scenarios where taking this approach towards element discovery is appropriate. - The property system will potentially recalculate all property values of an element when it is reparented, because some properties inherit values through the logical tree. The that applies for bindings can also change when elements are reparented. + The property system will potentially recalculate all property values of an element when it is reparented, because some properties inherit values through the logical tree. The that applies for bindings can also change when elements are reparented. Changing an element's parent is typically only done through manipulation of collections, by using dedicated add or remove methods, or through setting content properties of elements. - The most typical scenario for using the property is to obtain a reference and then get various property values from the parent. For templates, the of the template eventually will be `null`. To get past this point and extend into the logical tree where the template is actually applied, use . + The most typical scenario for using the property is to obtain a reference and then get various property values from the parent. For templates, the of the template eventually will be `null`. To get past this point and extend into the logical tree where the template is actually applied, use . ## Examples - The following example checks to see whether the of a is of a particular type. + The following example checks to see whether the of a is of a particular type. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkContentElement/Parent/Window1.xaml.cs" id="Snippetfceparent"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkContentElement/Parent/window1.xaml.vb" id="Snippetfceparent"::: @@ -2532,7 +2532,7 @@ is the related method that actually does move focus. + is the related method that actually does move focus. ]]> @@ -2574,9 +2574,9 @@ . The implementation will check successive parent elements until it finds the applicable implementation, which is found by finding an element that implements . For more information about namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). + This method is a convenience method for calling . The implementation will check successive parent elements until it finds the applicable implementation, which is found by finding an element that implements . For more information about namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). - Calling is necessary in order to correctly hook up animation storyboards for applications when created in code. This is because one of the key storyboard properties, , uses a run-time name lookup instead of being able to take a reference to a target element. This is true even if that element is accessible by reference from the code. For more information on why you need to register names for storyboard targets, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). Animations for content elements are less common than animations on controls, the [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview) concentrates on control scenarios. + Calling is necessary in order to correctly hook up animation storyboards for applications when created in code. This is because one of the key storyboard properties, , uses a run-time name lookup instead of being able to take a reference to a target element. This is true even if that element is accessible by reference from the code. For more information on why you need to register names for storyboard targets, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). Animations for content elements are less common than animations on controls, the [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview) concentrates on control scenarios. ]]> @@ -2619,7 +2619,7 @@ ## Remarks This API is mainly relevant for class deriving scenarios, when adding support for child collections. - Most derived classes expose dedicated collections that are responsible for containment (for example, on the class; on the class). Deriving from such classes typically can avoid any need to manipulate the logical tree directly. + Most derived classes expose dedicated collections that are responsible for containment (for example, on the class; on the class). Deriving from such classes typically can avoid any need to manipulate the logical tree directly. ]]> @@ -2691,7 +2691,7 @@ ## Examples - The following example establishes a collection on a root element. is a typical choice because it is one of the few classes that make sense as a root element, and resources are generally stored at the page root or at even higher levels such as in the application. + The following example establishes a collection on a root element. is a typical choice because it is one of the few classes that make sense as a root element, and resources are generally stored at the page root or at even higher levels such as in the application. :::code language="xaml" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page2.xaml" id="Snippetfceresources"::: @@ -2745,12 +2745,12 @@ , which passes the current instance as the , and creates a new based on the provided `path` parameter. This signature is more convenient if you are establishing a simple default binding. If you need to specify any binding properties to non-default conditions, or want to use a or ,you should use the signature. + This method is a convenience method for calling , which passes the current instance as the , and creates a new based on the provided `path` parameter. This signature is more convenient if you are establishing a simple default binding. If you need to specify any binding properties to non-default conditions, or want to use a or ,you should use the signature. ## Examples - The following example sets a binding on a element, by creating a new custom data object, establishing that object as , and setting the binding path to a property within it. + The following example sets a binding on a element, by creating a new custom data object, establishing that object as , and setting the binding path to a property within it. :::code language="csharp" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page1.xaml.cs" id="Snippetdatacontext"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/ContentElement/CaptureMouse/page1.xaml.vb" id="Snippetdatacontext"::: @@ -2795,7 +2795,7 @@ , which passes the current instance as the . + This method is a convenience method for calling , which passes the current instance as the . @@ -2891,7 +2891,7 @@ . + This will return `true` so long as there is at least one keyed resource in the local . ]]> @@ -3021,9 +3021,9 @@ ## Remarks The current style is often provided by a default style from theming, or from styles generally applied to objects of that type by resources at page or application level (an implicit style). This property does not set or return default (theme) styles, but it does return the implicit style or an explicit style. In the case of implicit or explicit styles, it does not matter whether the style is accessed as a resource or defined locally. - Setting the styles has some restrictions. You can reset the entire property to a new at any time, which will force a layout recomposition. However, as soon as that style is placed in use by a loaded element, the should be considered sealed. Attempting to make a change to any individual property of an in-use style (such as anything within the collection of ) causes an exception to be thrown. A style that is defined in markup is considered to be in use as soon as it is loaded from a resource dictionary (for resources), or the page it is contained within is loaded (for inline styles). + Setting the styles has some restrictions. You can reset the entire property to a new at any time, which will force a layout recomposition. However, as soon as that style is placed in use by a loaded element, the should be considered sealed. Attempting to make a change to any individual property of an in-use style (such as anything within the collection of ) causes an exception to be thrown. A style that is defined in markup is considered to be in use as soon as it is loaded from a resource dictionary (for resources), or the page it is contained within is loaded (for inline styles). - is a dependency property with special precedence. The locally set style generally operates at the highest precedence in the property system. If the is null at this point, during loading the property system checks for implicit styles as defined resources that specify that type. If the style is still null after this step, then the style comes from the default (theme) style, but the default style is not returned in the property value. See [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + is a dependency property with special precedence. The locally set style generally operates at the highest precedence in the property system. If the is null at this point, during loading the property system checks for implicit styles as defined resources that specify that type. If the style is still null after this step, then the style comes from the default (theme) style, but the default style is not returned in the property value. See [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). ## XAML Attribute Usage @@ -3049,12 +3049,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example establishes a collection on a root element and then references it as a resource as a specific style for a . + The following example establishes a collection on a root element and then references it as a resource as a specific style for a . :::code language="xaml" source="~/snippets/csharp/System.Windows/ContentElement/AllowDrop/page2.xaml" id="Snippetfceresources"::: @@ -3290,9 +3290,9 @@ value and continue to navigate that element tree as desired. + Templates are actually shared objects, where the contents of the template are created only once. Therefore, if you obtain an object reference to an element that came from a template, you may find that the apparent logical tree does not reach to the page root. In order to connect such a template reference to the page's logical tree, you should get the value and continue to navigate that element tree as desired. - will frequently be `null` for common objects, because if you have obtained an object reference from out of a page in your application through typical means, that element probably was not created from a template. Cases where might not be `null` would include operations such as hit-testing, event handling for certain low-level input events, or working with enumerators, which may have returned elements that came from templates. + will frequently be `null` for common objects, because if you have obtained an object reference from out of a page in your application through typical means, that element probably was not created from a template. Cases where might not be `null` would include operations such as hit-testing, event handling for certain low-level input events, or working with enumerators, which may have returned elements that came from templates. ]]> @@ -3371,10 +3371,10 @@ ## XAML Values *toolTipContent* - A string that becomes the display text for the . + A string that becomes the display text for the . *toolTipObjectContent* - Some object, provided in object element form, that should be used as the content for the . Typically this would be a or some other element that creates layout compositing for the , eventually containing text content within the compositing. In this usage, the element is created implicitly from the parsed XAML, and the *toolTipObjectContent* content is set as its property. + Some object, provided in object element form, that should be used as the content for the . Typically this would be a or some other element that creates layout compositing for the , eventually containing text content within the compositing. In this usage, the element is created implicitly from the parsed XAML, and the *toolTipObjectContent* content is set as its property. <`ToolTip` .../> See . @@ -3474,7 +3474,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> @@ -3509,7 +3509,7 @@ property will be used to automatically open a context menu. Marking the event handled will effectively cancel the default action, and could be an opportunity to reset the value of the property and then open the new . Note that this event will not be raised if is a null reference or otherwise unset. + To manually open tooltips, handlers of the events should mark the relevant event as handled. Otherwise, the value of the property will be used to automatically open a context menu. Marking the event handled will effectively cancel the default action, and could be an opportunity to reset the value of the property and then open the new . Note that this event will not be raised if is a null reference or otherwise unset. This event cannot be an in a style. This is because the identifier field of this event re-uses an implementation from a service that does not expose add/remove methods on the event. @@ -3555,7 +3555,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> @@ -3627,7 +3627,7 @@ Typically you would immediately cast the return value to the type of the property that you were attempting to set with the returned resource value. - The method has similar behavior, except that it will throw an exception in the case of not finding a resource with the provided key. + The method has similar behavior, except that it will throw an exception in the case of not finding a resource with the provided key. @@ -3715,7 +3715,7 @@ ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. + Event identifier objects are created when routed events are registered (see ) and can then be used to add class handlers (see ). Identifier objects contain an identifying name, owner type, handler type, routing strategy, and a utility method for adding owners for the event. ]]> diff --git a/xml/System.Windows/FrameworkElement.xml b/xml/System.Windows/FrameworkElement.xml index ce4af886d4d..1f39c7ebd70 100644 --- a/xml/System.Windows/FrameworkElement.xml +++ b/xml/System.Windows/FrameworkElement.xml @@ -69,7 +69,7 @@ extends and adds the following capabilities: -- **Layout system definition**: provides specific WPF framework-level implementations for certain methods that were defined as virtual members in . Most notably, seals certain WPF core-level layout overrides, and instead provides a WPF framework-level equivalent that derived classes should override instead. For example, seals but provides . These changes reflect the fact that at the WPF framework-level there is a full layout system in place that can render any derived class. At the WPF core level, certain members that will structure a general WPF based layout solution are in place, but the actual engine of the layout system is not defined. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). +- **Layout system definition**: provides specific WPF framework-level implementations for certain methods that were defined as virtual members in . Most notably, seals certain WPF core-level layout overrides, and instead provides a WPF framework-level equivalent that derived classes should override instead. For example, seals but provides . These changes reflect the fact that at the WPF framework-level there is a full layout system in place that can render any derived class. At the WPF core level, certain members that will structure a general WPF based layout solution are in place, but the actual engine of the layout system is not defined. For more information, see [Layout](/dotnet/framework/wpf/advanced/layout). - **The logical tree:** The general WPF programming model is often expressed in terms of being a tree of elements. Support for expressing the tree of elements as a logical tree, and accompanying support for defining that tree in markup is implemented at the level. Note however that deliberately does not define a content model, and leaves that responsibility to derived classes. For more information, see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). @@ -79,7 +79,7 @@ - **Styles:** defines the property. However, does not yet define support for templates, or support decorators. These features are introduced by control classes such as and . -- **More animation support:** Some animation support was already defined at the WPF core level, but extends this by implementing and related members. +- **More animation support:** Some animation support was already defined at the WPF core level, but extends this by implementing and related members. As can be seen from the class hierarchy, many WPF classes derive from , either directly or through intermediate base classes such as or . @@ -146,9 +146,9 @@ that are the basis of the input change. + This property is a calculated value based on other height inputs, and the layout system. The value is set by the layout system itself, based on an actual rendering pass, and may therefore lag slightly behind the set value of properties such as that are the basis of the input change. - Because is a calculated value, you should be aware that there could be multiple or incremental reported changes to it as a result of various operations by the layout system. The layout system may be calculating required measure space for child elements, constraints by the parent element, and so on. + Because is a calculated value, you should be aware that there could be multiple or incremental reported changes to it as a result of various operations by the layout system. The layout system may be calculating required measure space for child elements, constraints by the parent element, and so on. Although you cannot set this property from XAML, you can base a upon its value in a style. @@ -230,9 +230,9 @@ that are the basis of the input change. + This property is a calculated value based on other width inputs, and the layout system. The value is set by the layout system itself, based on an actual rendering pass, and may therefore lag slightly behind the set value of properties such as that are the basis of the input change. - Because is a calculated value, you should be aware that there could be multiple or incremental reported changes to it as a result of various operations by the layout system. The layout system may be calculating required measure space for child elements, constraints by the parent element, and so on. + Because is a calculated value, you should be aware that there could be multiple or incremental reported changes to it as a result of various operations by the layout system. The layout system may be calculating required measure space for child elements, constraints by the parent element, and so on. Although you cannot set this property from XAML, you can base a upon its value in a style. @@ -319,9 +319,9 @@ ## Remarks Use this method for the implementation of collections on objects that represent logical child elements of an element. Collection maintenance for child element collections might be done in property getters or setters, class handling of Changed events, constructors, or within the collection types themselves. - For control authors, manipulating the logical tree at this level is not the recommended practice, unless none of the content models for available base control classes are appropriate for your control scenario. Consider subclassing at the level of , , and . These classes provide a content model with particular enforcement of logical tree child elements through dedicated APIs, as well as support for other features typically desirable in a WPF control such as styling through templates. For more information on how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + For control authors, manipulating the logical tree at this level is not the recommended practice, unless none of the content models for available base control classes are appropriate for your control scenario. Consider subclassing at the level of , , and . These classes provide a content model with particular enforcement of logical tree child elements through dedicated APIs, as well as support for other features typically desirable in a WPF control such as styling through templates. For more information on how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). - may throw an exception if called at a time when the logical tree is being iterated by another process. + may throw an exception if called at a time when the logical tree is being iterated by another process. @@ -368,11 +368,11 @@ is not necessary, because templates will be applied to elements at an appropriate point in their lifetimes automatically. + Applications can call this method to guarantee that the visual tree of an element is complete. This guarantee step might be necessary if code will be checking the child elements in the tree. For typical element logic within applications, calling is not necessary, because templates will be applied to elements at an appropriate point in their lifetimes automatically. - is called on every Measure pass by the WPF framework-level layout system. + is called on every Measure pass by the WPF framework-level layout system. - derived classes can use the class handler to be notified of cases where this method was called explicitly, or by the layout system. is called after the template is completely generated and attached to the logical tree. + derived classes can use the class handler to be notified of cases where this method was called explicitly, or by the layout system. is called after the template is completely generated and attached to the logical tree. ]]> @@ -412,7 +412,7 @@ derived class must override . + This method is sealed. In order to override the logic in your custom element specifically for the arrange pass of element layout, your derived class must override . ]]> @@ -621,9 +621,9 @@ To avoid performance issues when you apply a large number of clocks by using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -689,9 +689,9 @@ To avoid performance issues when you apply a large number of clocks by using , you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock: -- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. +- To remove all clocks from a property, use the or method of the animated object. Specify the property being animated as the first parameter, and `null` as the second. This removes all animation clocks from the property. -- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . +- To remove a specific from a list of clocks, use the property of the to retrieve a , then call the method of the . This is typically done in the event handler for a clock. Note that only root clocks can be controlled by a ; the property of a child clock returns `null`. Note also that the event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call . This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected. @@ -751,7 +751,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -760,12 +760,12 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml" id="Snippetbindinggroupcomplete"::: - The following example shows the that the previous example uses. In the method override, the example gets each source object from the and checks whether the properties of the objects are equal. + The following example shows the that the previous example uses. In the method override, the example gets each source object from the and checks whether the properties of the objects are equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml.cs" id="Snippetbindinggroupnamevalidationrule"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window3.xaml.vb" id="Snippetbindinggroupnamevalidationrule"::: - To invoke the , call the method. The following example calls when the click event of the button occurs. + To invoke the , call the method. The following example calls when the click event of the button occurs. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BindingGroup/Window3.xaml.cs" id="Snippetupdatesourcesclick"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BindingGroup/window3.xaml.vb" id="Snippetupdatesourcesclick"::: @@ -841,16 +841,16 @@ event that originates from the current element. This event is raised so that it can be handled by a , or a derived or similar class. The expected behavior is that the event is handled by the parent element, marked handled in the event data, and the source of the event is brought into view through the logic embedded in the control. Neither the event nor the method transmit any information about success or failure, other than that the event is typically marked handled on success. Reasons for failure can include the element settings, such as being some value other than . + By calling this method, you raise a event that originates from the current element. This event is raised so that it can be handled by a , or a derived or similar class. The expected behavior is that the event is handled by the parent element, marked handled in the event data, and the source of the event is brought into view through the logic embedded in the control. Neither the event nor the method transmit any information about success or failure, other than that the event is typically marked handled on success. Reasons for failure can include the element settings, such as being some value other than . - If you use the signature that does not specify a `targetRectangle`, then the entire element size (its ) will be made visible. + If you use the signature that does not specify a `targetRectangle`, then the entire element size (its ) will be made visible. - By calling this method, you potentially will call on any parent scrollable area that contains the element. If this element is not contained in a scrollable area, the event is still raised, but there will be no effect because there are no event listeners. + By calling this method, you potentially will call on any parent scrollable area that contains the element. If this element is not contained in a scrollable area, the event is still raised, but there will be no effect because there are no event listeners. ## Examples - The following example implements a handler for an application navigation event that responds whenever the uniform resource identifier (URI) being navigated to includes a fragment. The fragment is named in the URI following the hash sign (#), and the implemented behavior causes the element to scroll into view within the frame. and request that scrolling behavior in the example. + The following example implements a handler for an application navigation event that responds whenever the uniform resource identifier (URI) being navigated to includes a fragment. The fragment is named in the URI following the hash sign (#), and the implemented behavior causes the element to scroll into view within the frame. and request that scrolling behavior in the example. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BringIntoView/MainWindow.xaml.cs" id="Snippetfebringintoview"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BringIntoView/MainWindow.xaml.vb" id="Snippetfebringintoview"::: @@ -893,11 +893,11 @@ event that originates from the current element. This event is raised so that it can be handled by a , or a derived or similar class. The expected behavior is that the event is handled by the parent element, marked handled in the event data, and the source of the event is brought into view through the logic embedded in the control. Neither the event nor the method transmit any information about success or failure, other than that the event is typically marked handled on success. Reasons for failure can include the element settings, such as being some value other than . + By calling this method, you raise a event that originates from the current element. This event is raised so that it can be handled by a , or a derived or similar class. The expected behavior is that the event is handled by the parent element, marked handled in the event data, and the source of the event is brought into view through the logic embedded in the control. Neither the event nor the method transmit any information about success or failure, other than that the event is typically marked handled on success. Reasons for failure can include the element settings, such as being some value other than . - If you use the signature that does not specify a `targetRectangle`, then the entire element size (its ) will be made visible. + If you use the signature that does not specify a `targetRectangle`, then the entire element size (its ) will be made visible. - By calling this method, you potentially will call on any parent scrollable area that contains the element. If this element is not contained in a scrollable area, the event is still raised, but there will be no effect because there are no event listeners. + By calling this method, you potentially will call on any parent scrollable area that contains the element. If this element is not contained in a scrollable area, the event is still raised, but there will be no effect because there are no event listeners. @@ -1009,7 +1009,7 @@ |Routing strategy|Bubbling| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1047,7 +1047,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1090,7 +1090,7 @@ (This usage is required because the event implementation on that exposes the underlying service event does not map the identifier such that you can use it in triggers). - itself is a derived class, but this event will not be raised from the context menu being opened as a source. The event is raised from the element that "owns" the context menu as a property and is only raised when a user attempts to open a context menu in the UI. It is possible for itself to have a property, but you should avoid this scenario (for details, see ). + itself is a derived class, but this event will not be raised from the context menu being opened as a source. The event is raised from the element that "owns" the context menu as a property and is only raised when a user attempts to open a context menu in the UI. It is possible for itself to have a property, but you should avoid this scenario (for details, see ). The class itself also has a similar event () but does not provide you the opportunity to cancel the user action. @@ -1103,7 +1103,7 @@ |Routing strategy|Bubbling| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -1141,7 +1141,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -1211,13 +1211,13 @@ To revert the behavior of setting this property to the eventual default, set it to `null` again. - The `null` default really means that determination of the practical cursor value is deferred here and should be obtained from elsewhere. If presented without programmatic values from any source, the default cursor that is visually over a Windows Presentation Foundation (WPF) application will be an arrow. However, the transient cursor changes are not set to the values of the elements when they are passed over. The property will only report non null values in cases where it was actually set, for instance through code or a style. Each movement of the mouse over a WPF application raises a event. The event bubbles, and any element along the route has the opportunity to handle the event and to set the value of the cursor through the arguments of this event. This is the mechanism that produces the visually apparent cursor in most cases. If a handler returns a cursor result, then the fact that the event is handled and has a changed value in the arguments takes precedence over the value of the property at any level, unless is set. + The `null` default really means that determination of the practical cursor value is deferred here and should be obtained from elsewhere. If presented without programmatic values from any source, the default cursor that is visually over a Windows Presentation Foundation (WPF) application will be an arrow. However, the transient cursor changes are not set to the values of the elements when they are passed over. The property will only report non null values in cases where it was actually set, for instance through code or a style. Each movement of the mouse over a WPF application raises a event. The event bubbles, and any element along the route has the opportunity to handle the event and to set the value of the cursor through the arguments of this event. This is the mechanism that produces the visually apparent cursor in most cases. If a handler returns a cursor result, then the fact that the event is handled and has a changed value in the arguments takes precedence over the value of the property at any level, unless is set. - If not are not creating a custom cursor, you typically set this property to a static property value of the class. Setting in code requires one of the following: + If not are not creating a custom cursor, you typically set this property to a static property value of the class. Setting in code requires one of the following: - Call the constructor to get a instance. Both signatures of the constructor use streams or files, in anticipation that you are creating the object for a custom cursor. -- Use the class and its method to specify a cursor by , or a string that can evaluate to a , and cast the return to . +- Use the class and its method to specify a cursor by , or a string that can evaluate to a , and cast the return to . Setting the to a custom value is not enabled in partial trust. For more information on custom cursors, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). @@ -1316,19 +1316,19 @@ Data context can be set directly to a .NET object, with the bindings evaluating to properties of that object. Alternatively, you can set the data context to a object. - This dependency property inherits property values. If there are child elements without other values for established through local values or styles, then the property system will set the value to be the value of the nearest parent element with this value assigned. + This dependency property inherits property values. If there are child elements without other values for established through local values or styles, then the property system will set the value to be the value of the nearest parent element with this value assigned. Alternatively, you can use one of the following properties of the class to specify the binding source explicitly: - - . - - . - - . + - . + - . + - . For more information, see [How to: Specify the Binding Source](/dotnet/framework/wpf/data/how-to-specify-the-binding-source). - In XAML, is most typically set as a declaration. You can use either property element syntax or attribute syntax. Attribute syntax is shown in the example on this page. You can also use code to set . + In XAML, is most typically set as a declaration. You can use either property element syntax or attribute syntax. Attribute syntax is shown in the example on this page. You can also use code to set . - is a bindable property to facilitate scenarios where one context might be bound to another. However, if you bind to , be careful to not create circular binding references (do not bind a to itself, which it is possible to do because of the property value inheritance nature of the property). + is a bindable property to facilitate scenarios where one context might be bound to another. However, if you bind to , be careful to not create circular binding references (do not bind a to itself, which it is possible to do because of the property value inheritance nature of the property). ## XAML Property Element Usage @@ -1374,7 +1374,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -1421,7 +1421,7 @@ For an explanation of data contexts and data binding, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). > [!IMPORTANT] -> When the for an element changes, all data-bound properties on this element are potentially affected. This applies to any elements that are child elements of the current element in the logical tree, which inherit the data context, and also the current element itself. All such existing bindings must re-interpret the new and will reevaluate the binding results. The data binding engine is not deterministic about the order of these reevaluations, relative to the raising of the event. The reevaluations can occur before the event, after the event, or in any mixture. +> When the for an element changes, all data-bound properties on this element are potentially affected. This applies to any elements that are child elements of the current element in the logical tree, which inherit the data context, and also the current element itself. All such existing bindings must re-interpret the new and will reevaluate the binding results. The data binding engine is not deterministic about the order of these reevaluations, relative to the raising of the event. The reevaluations can occur before the event, after the event, or in any mixture. ]]> @@ -1486,7 +1486,7 @@ derived class. When you derive a control, call the method against the identifier, within the static constructor of the control derived class (or equivalent class initialization). + This property is typically not set through any of its direct property accessors. Instead, you override the type-specific metadata of this dependency property every time you create a new derived class. When you derive a control, call the method against the identifier, within the static constructor of the control derived class (or equivalent class initialization). A control typically overrides the default value of this property to be its own type, but in some cases could also use a base type for which a style in the theme dictionaries exists. This is only practical if the control templates of the base control entirely define the visual representation of that derived control, and if whatever additional members the derived types expose do not require additional elements as part of the control template. @@ -1498,12 +1498,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example illustrates the dependency property metadata override usage discussed in Remarks. This code defines a custom control class `NumericUpDown` intended to be used from a dedicated control library assembly. The illustrated static constructor references some private initialization function, registers a class handler (another common control subclassing scenario; see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling)) and finally overrides the dependency property metadata on the `NumericUpDown` class. always returns its own type as the intended key, which is the convention that the theme style system uses to look up the style for some arbitrary otherwise non-styled control. + The following example illustrates the dependency property metadata override usage discussed in Remarks. This code defines a custom control class `NumericUpDown` intended to be used from a dedicated control library assembly. The illustrated static constructor references some private initialization function, registers a class handler (another common control subclassing scenario; see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling)) and finally overrides the dependency property metadata on the `NumericUpDown` class. always returns its own type as the intended key, which is the convention that the theme style system uses to look up the style for some arbitrary otherwise non-styled control. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/DefaultStyleKey/NumericUpDown2.cs"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/CustomControlNumericUpDown/visualbasic/customcontrollibrary/numericupdown2.vb"::: @@ -1576,7 +1576,7 @@ was previously called, the base implementation will raise the event. Otherwise, if was not called or it could not be determined whether was called, is not raised and an exception is thrown instead. + If was previously called, the base implementation will raise the event. Otherwise, if was not called or it could not be determined whether was called, is not raised and an exception is thrown instead. ]]> @@ -1625,7 +1625,7 @@ ## Remarks If the element has child elements, these child elements are all searched recursively for the requested named element. - operates within the current element's namescope. For details, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). + operates within the current element's namescope. For details, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). ]]> @@ -1670,11 +1670,11 @@ ## Remarks > [!IMPORTANT] -> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions that result from calling , call instead. returns `null` when a requested resource cannot be found, and does not throw an exception. +> If you call this method for a key that cannot be found, an exception is thrown. If you do not want to handle exceptions that result from calling , call instead. returns `null` when a requested resource cannot be found, and does not throw an exception. If the resource is not found on the calling element, the parent element in the logical tree is searched next, then the application, then themes, and finally system resources. This lookup methodology is identical to how the tree is searched if a resource were requested by a dynamic resource reference in markup. For more information about resource lookup, see [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). - Typically, you immediately cast a return value to the type of the property that you setting with the returned resource value. + Typically, you immediately cast a return value to the type of the property that you setting with the returned resource value. Resource keys are not necessarily strings. For instance, styles for controls at the theme level are deliberately keyed to the of the control, and application or page styles for controls typically use this same key convention. For details, see [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating) or [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). @@ -1735,7 +1735,7 @@ on this element. Because of property value inheritance, setting on an element can potentially set on all child elements that did not set locally or though other means such as styles. + The dependency property usage sets the on this element. Because of property value inheritance, setting on an element can potentially set on all child elements that did not set locally or though other means such as styles. This property is not automatically set as part of any application culture information, because an element might contain content that is not necessarily intended to obey the general flow direction implied by the culture information. For more information on globalization considerations, see [Globalization for WPF](/dotnet/framework/wpf/advanced/globalization-for-wpf). @@ -1757,7 +1757,7 @@ | Item | Properties or fields | |-|-| |Identifier field|| -|Metadata properties set to `true`|, , | +|Metadata properties set to `true`|, , | This property is both a dependency property and an attached property; see Remarks. @@ -1823,9 +1823,9 @@ in metadata. This is because the visual appearance change is event-driven and may not apply at all times, and therefore should not generally report any visual or layout information in metadata. + This property affects visual appearance but does not report in metadata. This is because the visual appearance change is event-driven and may not apply at all times, and therefore should not generally report any visual or layout information in metadata. - Conceptually, the visual behavior of focus applied to a control should be coherent from control to control. The most sensible way to enforce coherence is to only change the focus visual style if you are composing an entire theme. Setting this property on individual control styles and not as part of a theme is not the intended usage of this property, because it may lead to a confusing user experience regarding keyboard focus. If you are intending control-specific behavior that is deliberately not coherent across a theme, a much better approach is to use triggers in styles for individual input state properties, such as or , and to do so in a way that does not visually interfere with any existing focus visual style. For more information on the design intention of and alternative focus properties, see [Styling for Focus in Controls, and FocusVisualStyle](/dotnet/framework/wpf/advanced/styling-for-focus-in-controls-and-focusvisualstyle). + Conceptually, the visual behavior of focus applied to a control should be coherent from control to control. The most sensible way to enforce coherence is to only change the focus visual style if you are composing an entire theme. Setting this property on individual control styles and not as part of a theme is not the intended usage of this property, because it may lead to a confusing user experience regarding keyboard focus. If you are intending control-specific behavior that is deliberately not coherent across a theme, a much better approach is to use triggers in styles for individual input state properties, such as or , and to do so in a way that does not visually interfere with any existing focus visual style. For more information on the design intention of and alternative focus properties, see [Styling for Focus in Controls, and FocusVisualStyle](/dotnet/framework/wpf/advanced/styling-for-focus-in-controls-and-focusvisualstyle). ## XAML Attribute Usage @@ -1920,7 +1920,7 @@ is more appropriate in control subclassing or compositing scenarios. + If you set this property to `true` you will override the cursor preferences established by child elements. Doing so in general application UI might be confusing for the user, particularly if child elements are attempting to specify cursors. Setting is more appropriate in control subclassing or compositing scenarios. ## Dependency Property Information @@ -2006,7 +2006,7 @@ ## Remarks Checking the return value for `null` is a technique you can use to determine whether a property has an active binding. - This method is really just a convenience wrapper around the method. passes the current instance and the `dp` parameter to . + This method is really just a convenience wrapper around the method. passes the current instance and the `dp` parameter to . ]]> @@ -2047,7 +2047,7 @@ property, therefore allowing child elements of a provided to specify flow direction for the arrangement within their parent element. To get the value on the current , use the direct common language runtime (CLR) accessor . + The main purpose of this method is to support attached property syntax for the property, therefore allowing child elements of a provided to specify flow direction for the arrangement within their parent element. To get the value on the current , use the direct common language runtime (CLR) accessor . ]]> @@ -2090,7 +2090,7 @@ ## Remarks Margins will be subtracted from the `layoutSlotSize` as part of layout system behavior. - A returned null reference indicates that no clipping will occur. The default implementation always returns `null` when is `false`. This method overrides . The implementation uses and in its calculations. Several subclasses of override this method again. , overrides to always return `null` because adorners are often deliberately outside the ordinary bounds. and return `null` if is `false`. + A returned null reference indicates that no clipping will occur. The default implementation always returns `null` when is `false`. This method overrides . The implementation uses and in its calculations. Several subclasses of override this method again. , overrides to always return `null` because adorners are often deliberately outside the ordinary bounds. and return `null` if is `false`. ]]> @@ -2135,9 +2135,9 @@ method to return references to objects that come from the template after it is instantiated. You cannot use the method to find items from templates because acts in a more general scope, and there is no connection between the class itself and the instantiated template once it is applied. + Templates in WPF have a self-contained namescope. This is because templates are re-used, and any name defined in a template cannot remain unique when multiple instances of a control each instantiate its template. Call the method to return references to objects that come from the template after it is instantiated. You cannot use the method to find items from templates because acts in a more general scope, and there is no connection between the class itself and the instantiated template once it is applied. - supplies the same function as this method. is public instead of protected, and it uses correct name-scoping considerations that allow it to access the template within an element and find named items within it. Use when you need to get an element outside of its parent control. + supplies the same function as this method. is public instead of protected, and it uses correct name-scoping considerations that allow it to access the template within an element and find named items within it. Use when you need to get an element outside of its parent control. ]]> @@ -2175,7 +2175,7 @@ . The default implementation returns the expected single visual parent, which is the same result as getting the value. Derived class implementations might return alternate parent relationships. + This method overrides . The default implementation returns the expected single visual parent, which is the same result as getting the value. Derived class implementations might return alternate parent relationships. ]]> @@ -2216,12 +2216,12 @@ implementation, the only valid index is zero. The content model for supports either zero or one child elements, not a collection. + In the implementation, the only valid index is zero. The content model for supports either zero or one child elements, not a collection. ## Examples - The following example shows how a custom adorner uses the values declared by a that it maintains for its multiple visual children. These values are reported through overrides of and . + The following example shows how a custom adorner uses the values declared by a that it maintains for its multiple visual children. These values are reported through overrides of and . :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/GetVisualChild/ResizingAdorner.cs" id="Snippetfevisualoverridespre"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/GetVisualChild/resizingadorner.vb" id="Snippetfevisualoverridespre"::: @@ -2277,17 +2277,17 @@ is one of three writable properties on that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is that first must be honored, then , and finally, if it is within bounds, . + is one of three writable properties on that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is that first must be honored, then , and finally, if it is within bounds, . - If this element is a child element within some other element, then setting this property to a value is really only a suggested value. The layout system as well as the particular layout logic of the parent element will use the value as a nonbinding input during the layout process. In practical terms, a is almost always the child element of something else; even when you set the on . (For , that value is used when the underlying application model establishes the basic rendering assumptions that create the Hwnd that hosts the application.) + If this element is a child element within some other element, then setting this property to a value is really only a suggested value. The layout system as well as the particular layout logic of the parent element will use the value as a nonbinding input during the layout process. In practical terms, a is almost always the child element of something else; even when you set the on . (For , that value is used when the underlying application model establishes the basic rendering assumptions that create the Hwnd that hosts the application.) In addition to acceptable values, this property can also be . This is how you specify auto sizing behavior in code. In XAML you set the value to the string "Auto" (case insensitive) to enable the auto sizing behavior. Auto sizing behavior implies that the element will fill the height available to it. Note however that specific controls frequently supply default values through their default theme styles that will disable the auto sizing behavior unless it is specifically re-enabled. - The return value of this property is always the same as any value that was set to it. In contrast, the value of the may vary. This can happen either statically because the layout rejected the suggested size for some reason, or momentarily. The layout system itself works asynchronously relative to the property system's set of and may not have processed that particular sizing property change yet. + The return value of this property is always the same as any value that was set to it. In contrast, the value of the may vary. This can happen either statically because the layout rejected the suggested size for some reason, or momentarily. The layout system itself works asynchronously relative to the property system's set of and may not have processed that particular sizing property change yet. The value restrictions on the value are enforced by a mechanism. If you attempt to set an invalid value, a run-time exception is thrown. - In addition to the validation check, there is a nondeterministic upper value bound for that is enforced by the layout system (this is a very large number, larger than but smaller than ). If you exceed this bound, the element will not render, and no exception is thrown. Do not set to a value that is significantly larger than the maximum size of any possible visual display, or you may exceed this nondeterministic upper bound. + In addition to the validation check, there is a nondeterministic upper value bound for that is enforced by the layout system (this is a very large number, larger than but smaller than ). If you exceed this bound, the element will not render, and no exception is thrown. Do not set to a value that is significantly larger than the maximum size of any possible visual display, or you may exceed this nondeterministic upper bound. ## XAML Attribute Usage @@ -2335,7 +2335,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2400,11 +2400,11 @@ and properties are explicitly set on an element, these measurements take higher precedent during layout and will cancel the typical effects of setting to . + When and properties are explicitly set on an element, these measurements take higher precedent during layout and will cancel the typical effects of setting to . - is the Microsoft .NET property accessor for what is in reality a dependency property. This particular dependency property quite frequently has its apparent "default" value set differently in subclassed elements, particularly controls. This generally occurs in one of two ways: the dependency property is re-registered to a particular subclass, but with different metadata for setting its defaults; or there is a default style being applied that sets that dependency property value differently. For example, the apparent "default" of for a control will be , even though inherits direct from . This is because that value was reset within the default style of , within the style's control template. + is the Microsoft .NET property accessor for what is in reality a dependency property. This particular dependency property quite frequently has its apparent "default" value set differently in subclassed elements, particularly controls. This generally occurs in one of two ways: the dependency property is re-registered to a particular subclass, but with different metadata for setting its defaults; or there is a default style being applied that sets that dependency property value differently. For example, the apparent "default" of for a control will be , even though inherits direct from . This is because that value was reset within the default style of , within the style's control template. - does not use when composing layout, because is based on absolute positioning. + does not use when composing layout, because is based on absolute positioning. When inherited by or derived classes, redefines the default value of this dependency property to be . @@ -2414,7 +2414,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2478,7 +2478,7 @@ to deliberately limit the scope of inheritance behavior, to a force resource lookup to check the application resources, or to prevent a RelativeSource FindAncestor lookup from querying the current element or any further. RelativeSource FindAncestor lookup occurs when a binding uses a that has its property set to the value. + Certain boundaries in the element tree set to deliberately limit the scope of inheritance behavior, to a force resource lookup to check the application resources, or to prevent a RelativeSource FindAncestor lookup from querying the current element or any further. RelativeSource FindAncestor lookup occurs when a binding uses a that has its property set to the value. If you want your derived class to set this property, you should do so within the static constructor or in other initialization routines. @@ -2522,7 +2522,7 @@ or methods are called. Calls to either method could have come from application code, or through the Extensible Application Markup Language (XAML) processor behavior when a XAML page is processed. + This event will be raised whenever the or methods are called. Calls to either method could have come from application code, or through the Extensible Application Markup Language (XAML) processor behavior when a XAML page is processed. Whether you choose to handle or depends on your requirements. If you do not need to read element properties, intend to reset properties, and do not need any layout information, might be the better event to act upon. If you need all properties of the element to be available, and you will be setting properties that are likely to reset the layout, might be the better event to act upon. Be careful of reentrancy if your handler resets any properties that are interpreted by the layout system to mean that a new layout pass is required. (You might need to check the values on the property if you are unsure of which properties can require a new layout pass if they are changed.) @@ -2563,7 +2563,7 @@ established through local values or styles, then the property system will set the value to be the value of the nearest ancestor element with this value assigned. + This dependency property inherits property values. If there are child elements without other values for established through local values or styles, then the property system will set the value to be the value of the nearest ancestor element with this value assigned. Although a XAML syntax usage is listed and is syntactically allowed, setting this property in XAML is not common. @@ -2573,7 +2573,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2652,7 +2652,7 @@ ## Remarks This property may also be `true` if this element has been moved within the logical tree such that it has a new parent element, and therefore becomes reloaded again. - This property is useful if you also are using and . Elements in the logical tree that is loaded by a XAML processor are assured to be initialized. Elements not in the logical tree are initialized when is called. In absence of any specific handling of and , this will happen as soon as the constructor returns the initialized result. + This property is useful if you also are using and . Elements in the logical tree that is loaded by a XAML processor are assured to be initialized. Elements not in the logical tree are initialized when is called. In absence of any specific handling of and , this will happen as soon as the constructor returns the initialized result. ]]> @@ -2691,12 +2691,12 @@ ## Remarks From a newly constructed , this property starts off `false`, and remains `true` after it is set to `true`, even if the element is subsequently removed from a connected logical tree by code. `true` state is set by the general presentation logic when elements are loaded into the presentation engine. - Typically, loaded elements are rendered, but not all derived classes have a presentation, and other properties such as can influence presentation. + Typically, loaded elements are rendered, but not all derived classes have a presentation, and other properties such as can influence presentation. ## Examples - The following example implements two handlers: one is handling the event of the root element, so it is certain that the page root element is loaded because that is the significance of the event. The other handler is hooked to a user control, and calls to assure that the root element is loaded completely. Both handlers call the same function (not shown) that will populate child elements with fresh data. + The following example implements two handlers: one is handling the event of the root element, so it is certain that the page root element is loaded because that is the significance of the event. The other handler is hooked to a user control, and calls to assure that the root element is loaded completely. Both handlers call the same function (not shown) that will populate child elements with fresh data. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/IsLoaded/Page1.xaml.cs" id="Snippetfeisloaded"::: @@ -2737,9 +2737,9 @@ ## Remarks The string formats follow the RFC 3066 standard. For example, U.S. English is "en-US". For more information on the values and format, see . - This dependency property inherits property values. If there are child elements without other values for established through local values or styles, the property system will set the value to be the value of the nearest ancestor element with this value assigned. + This dependency property inherits property values. If there are child elements without other values for established through local values or styles, the property system will set the value to be the value of the nearest ancestor element with this value assigned. - XML defines the general meaning of the `xml:lang` attribute. essentially exposes the meaning of this attribute as a dependency property. can be adjusted programmatically, and can participate in property system value inheritance in a way that parallels how the `xml:lang` attribute can inherit to child element scope in XML. If you set , that value becomes the `xml:lang` and overwrites any previous value. For more information, see [xml:lang Handling in XAML](/dotnet/framework/xaml-services/xml-lang-handling-in-xaml). + XML defines the general meaning of the `xml:lang` attribute. essentially exposes the meaning of this attribute as a dependency property. can be adjusted programmatically, and can participate in property system value inheritance in a way that parallels how the `xml:lang` attribute can inherit to child element scope in XML. If you set , that value becomes the `xml:lang` and overwrites any previous value. For more information, see [xml:lang Handling in XAML](/dotnet/framework/xaml-services/xml-lang-handling-in-xaml). ## Dependency Property Information @@ -2747,7 +2747,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -2811,13 +2811,13 @@ , will affect results of layout. + In contrast to , will affect results of layout. - Setting a transform provides powerful capabilities of scaling and rotating. However, ignores operations. This is because the layout system behavior for child elements of a auto-corrects any offsets to the position of a scaled or rotated element into the layout and coordinate system of the parent element. + Setting a transform provides powerful capabilities of scaling and rotating. However, ignores operations. This is because the layout system behavior for child elements of a auto-corrects any offsets to the position of a scaled or rotated element into the layout and coordinate system of the parent element. - can lead to poor application performance if you invoke it in a scenario that does not require a full pass by the layout system. When you apply a to the collection of the , it triggers a new pass by the layout system and forces all on-screen objects to be remeasured and rearranged. If you are updating the complete application user interface (UI), this functionality might be exactly what you need. However, if you do not need a full layout pass, use the property, which does not invoke the layout system, and therefore, is typically a better choice for this scenario. + can lead to poor application performance if you invoke it in a scenario that does not require a full pass by the layout system. When you apply a to the collection of the , it triggers a new pass by the layout system and forces all on-screen objects to be remeasured and rearranged. If you are updating the complete application user interface (UI), this functionality might be exactly what you need. However, if you do not need a full layout pass, use the property, which does not invoke the layout system, and therefore, is typically a better choice for this scenario. - Example scenarios where would be useful include: rotating elements such as menu components from horizontal to vertical or vice versa, scaling elements (zooming in) on focus, providing editing behavior, etc. + Example scenarios where would be useful include: rotating elements such as menu components from horizontal to vertical or vice versa, scaling elements (zooming in) on focus, providing editing behavior, etc. ## Dependency Property Information @@ -2825,12 +2825,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example shows how to apply a to an element. The example creates an instance of and hosts it within a parent . It also uses the property to apply a to the . + The following example shows how to apply a to an element. The example creates an instance of and hosts it within a parent . It also uses the property to apply a to the . :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/LayoutTransform/CPP/LayoutTransform.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/LayoutTransform/LayoutTransform.cs" id="Snippet1"::: @@ -2951,7 +2951,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -2987,9 +2987,9 @@ allows you to iterate over child elements. This is useful for elements that may not have a defined, dedicated collection but still contain more than one child element, particularly child elements. + allows you to iterate over child elements. This is useful for elements that may not have a defined, dedicated collection but still contain more than one child element, particularly child elements. - For more information on how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). + For more information on how to use and , see [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf). ]]> @@ -3028,13 +3028,13 @@ ## Remarks The margin is the space between this element and other elements that will be adjacent when layout creates the user interface (UI). Shared elements might be peer elements (such as other elements in the collection of a common parent control), or might also be this element's parent. - is set as a structure rather than as a number so that the margin can be set asymmetrically. The structure itself supports string type conversion so that you can specify an asymmetric in XAML attribute syntax also. + is set as a structure rather than as a number so that the margin can be set asymmetrically. The structure itself supports string type conversion so that you can specify an asymmetric in XAML attribute syntax also. - A non-zero margin applies space outside the element layout's and . + A non-zero margin applies space outside the element layout's and . Margins are additive for sibling elements in a layout; for example, two adjacent elements both with a margin of 30 set on the adjoining edge would have 60 units of space between them. - Elements that have margins set will not typically constrain the size of the specified if the allotted rectangle space is not large enough for the margin plus the element content area. The element content area will be constrained instead when layout is calculated. The only case where margins would be constrained also is if the content is already constrained all the way to zero. + Elements that have margins set will not typically constrain the size of the specified if the allotted rectangle space is not large enough for the margin plus the element content area. The element content area will be constrained instead when layout is calculated. The only case where margins would be constrained also is if the content is already constrained all the way to zero. ## XAML Attribute Usage @@ -3071,7 +3071,7 @@ *left, top, right, bottom* Number values between 0 and that specify the four possible dimension properties of a structure. - The attribute usage will also accept abbreviated values that apply in the order provided, symmetrically and logically. For instance, `Margin="20"` will be interpreted to mean a with all properties set to 20. `Margin="20,50"` will be interpreted to mean a with and set to 20, and and set to 50. + The attribute usage will also accept abbreviated values that apply in the order provided, symmetrically and logically. For instance, `Margin="20"` will be interpreted to mean a with all properties set to 20. `Margin="20,50"` will be interpreted to mean a with and set to 20, and and set to 50. The default unit for a measure is device-independent unit (1/96th inch). You can also specify other units by appending the unit type strings `cm`, `in`, or `pt` to any measure. @@ -3086,7 +3086,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3161,7 +3161,7 @@ that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is first must be honored, then , and finally if each of these are within bounds, . + This is one of three properties on that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is first must be honored, then , and finally if each of these are within bounds, . The value restrictions on the value are enforced by a mechanism. If you attempt to set an invalid value a run-time exception is thrown. @@ -3204,7 +3204,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3278,7 +3278,7 @@ that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . + This is one of three properties on that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . The value restrictions on the value are enforced by a mechanism. If you attempt to set an invalid value, a run-time exception is thrown. @@ -3321,7 +3321,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3389,7 +3389,7 @@ to connect the WPF core-level and WPF framework-level layout measure implementations. The implementation seals the method. To adjust the measure pass layout behavior of any element that builds on the WPF framework-level, override instead. To adjust the measure pass layout behavior of an element that deliberately does not build on the WPF framework-level or use , override . + This method overrides to connect the WPF core-level and WPF framework-level layout measure implementations. The implementation seals the method. To adjust the measure pass layout behavior of any element that builds on the WPF framework-level, override instead. To adjust the measure pass layout behavior of an element that deliberately does not build on the WPF framework-level or use , override . ]]> @@ -3429,20 +3429,20 @@ to implement custom layout sizing behavior for your element as it participates in the Windows Presentation Foundation (WPF) layout system. Your implementation should do the following: + Override to implement custom layout sizing behavior for your element as it participates in the Windows Presentation Foundation (WPF) layout system. Your implementation should do the following: -1. Iterate your element's particular collection of children that are part of layout, call on each child element. +1. Iterate your element's particular collection of children that are part of layout, call on each child element. -2. Immediately get on the child (this is set as a property after is called). +2. Immediately get on the child (this is set as a property after is called). 3. Compute the net desired size of the parent based upon the measurement of the child elements. - The return value of should be the element's own desired size, which then becomes the measure input for the parent element of the current element. This same process continues through the layout system until the root element of the page is reached. + The return value of should be the element's own desired size, which then becomes the measure input for the parent element of the current element. This same process continues through the layout system until the root element of the page is reached. - During this process, child elements might return a larger size than the initial `availableSize` to indicate that the child element wants more space. This might be handled in your own implementation by introducing a scrollable region, by resizing the parent control, by establishing some manner of stacked order, or any number of solutions for measuring or arranging content. + During this process, child elements might return a larger size than the initial `availableSize` to indicate that the child element wants more space. This might be handled in your own implementation by introducing a scrollable region, by resizing the parent control, by establishing some manner of stacked order, or any number of solutions for measuring or arranging content. > [!IMPORTANT] -> Elements should call on each child during this process, otherwise the child elements will not be correctly sized or arranged. +> Elements should call on each child during this process, otherwise the child elements will not be correctly sized or arranged. ]]> @@ -3494,7 +3494,7 @@ that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is first must be honored, then , and finally if each of these are within bounds, . + This is one of three properties on that specify height information. The other two are and . If there is a conflict between these values, the order of application for actual height determination is first must be honored, then , and finally if each of these are within bounds, . The value restrictions on the value are enforced by a mechanism. If you attempt to set an invalid value, a run-time exception is thrown. @@ -3537,7 +3537,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3611,7 +3611,7 @@ that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . + This is one of three properties on that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . The value restrictions on the value are enforced by a mechanism. If you attempt to set an invalid value, a run-time exception is thrown. @@ -3654,7 +3654,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -3722,12 +3722,12 @@ and seals the method. + This implementation overrides and seals the method. ## Examples - The following example implements a handler that handles several possible button inputs. Each button represents a possible . The handler tracks the element with current keyboard focus, and calls on that element, by specifying the appropriate as initialization for the type parameter provided. + The following example implements a handler that handles several possible button inputs. Each button represents a possible . The handler tracks the element with current keyboard focus, and calls on that element, by specifying the appropriate as initialization for the type parameter provided. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/MoveFocus/Window1.xaml.cs" id="Snippetfocussamplemovefocus"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/MoveFocus/window1.xaml.vb" id="Snippetfocussamplemovefocus"::: @@ -3791,19 +3791,19 @@ Names must be unique within a namescope. For more information, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). - Getting a if you are creating elements in code is not common. If you have the appropriate reference in code already, you can just call methods and properties on the element reference and will not generally need the . An exception to this is if the string has some overloaded meaning, for instance if it is useful to display that name in UI. Setting a from code-behind if the original was set from markup is also not recommended, and changing the property after loading the XAML will not change the original object reference. The object references are created only when the underlying namescopes are explicitly created during parsing. You must specifically call to make an effective change to the property of an already loaded element. + Getting a if you are creating elements in code is not common. If you have the appropriate reference in code already, you can just call methods and properties on the element reference and will not generally need the . An exception to this is if the string has some overloaded meaning, for instance if it is useful to display that name in UI. Setting a from code-behind if the original was set from markup is also not recommended, and changing the property after loading the XAML will not change the original object reference. The object references are created only when the underlying namescopes are explicitly created during parsing. You must specifically call to make an effective change to the property of an already loaded element. - One notable case where setting from code is important is when registering names for elements that storyboards will run against, so that they can be referenced at run time. Before you can register a name, might also need to instantiate and assign a instance. See the Example section, or [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). + One notable case where setting from code is important is when registering names for elements that storyboards will run against, so that they can be referenced at run time. Before you can register a name, might also need to instantiate and assign a instance. See the Example section, or [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). - Setting from code has limited applications, but getting an element by is more common. One particular scenario is if your application supports a navigation model where pages reload into the application, and the run time code is not necessarily code-behind defined for that page. The utility method , which is available from any , can find any element by in the logical tree for that element, searching the tree recursively as necessary. Or you can use the static method of , which also takes a string as an argument. + Setting from code has limited applications, but getting an element by is more common. One particular scenario is if your application supports a navigation model where pages reload into the application, and the run time code is not necessarily code-behind defined for that page. The utility method , which is available from any , can find any element by in the logical tree for that element, searching the tree recursively as necessary. Or you can use the static method of , which also takes a string as an argument. Typically used root elements (, for example) implement the interface . Implementations of this interface are expected to enforce that names be unambiguous within their scope. The root elements that define this interface also define the namescope behavior boundaries for all the related APIs. - The property also serves as an identifier for other processes. For instance, the WPF automation model will use as the AutomationId for clients and providers. + The property also serves as an identifier for other processes. For instance, the WPF automation model will use as the AutomationId for clients and providers. - The string values used for have some restrictions, as imposed by the underlying [x:Name Directive](/dotnet/framework/xaml-services/x-name-directive) defined by the XAML specification. Most notably, a must start with a letter or the underscore character (_), and must contain only letters, digits, or underscores. For more information, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). + The string values used for have some restrictions, as imposed by the underlying [x:Name Directive](/dotnet/framework/xaml-services/x-name-directive) defined by the XAML specification. Most notably, a must start with a letter or the underscore character (_), and must contain only letters, digits, or underscores. For more information, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). - is one of the very few dependency properties that cannot be animated ( is `true` in metadata), because the name itself is vital for targeting an animation. Data binding a is technically possible, but is an extremely uncommon scenario because a data-bound cannot serve the main intended purpose of the property: to provide an identifier connection point for code-behind. + is one of the very few dependency properties that cannot be animated ( is `true` in metadata), because the name itself is vital for targeting an animation. Data binding a is technically possible, but is an extremely uncommon scenario because a data-bound cannot serve the main intended purpose of the property: to provide an identifier connection point for code-behind. ## Dependency Property Information @@ -3811,12 +3811,12 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ## Examples - The following example sets the property in code, and then registers the name into the newly created by calling . The technique illustrated here is a requirement for animating with storyboards, because storyboards require targeting by the , and cannot be targeted by object reference. + The following example sets the property in code, and then registers the name into the newly created by calling . The technique illustrated here is a requirement for animating with storyboards, because storyboards require targeting by the , and cannot be targeted by object reference. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/Name/AnimatedHeightExample.cs" id="Snippetfename"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/Name/animatedheightexample.vb" id="Snippetfename"::: @@ -4021,9 +4021,9 @@ does have a default implementation. Specifically, it has an implementation that overrides the null implementation in the next level of base element down, . When invoked, sets appropriate focus behavior on this element in cases where the event originated from the current element due to keyboard focus. The handler does not mark the event arguments as handled, even when focus is set to the current element. If the event's source was another element in the tree (not the current element), the handler does nothing. + Unlike some other On* methods exposed by the base elements, does have a default implementation. Specifically, it has an implementation that overrides the null implementation in the next level of base element down, . When invoked, sets appropriate focus behavior on this element in cases where the event originated from the current element due to keyboard focus. The handler does not mark the event arguments as handled, even when focus is set to the current element. If the event's source was another element in the tree (not the current element), the handler does nothing. - You can override this method in order to change the default focus behavior on your element, but be aware that changing focus behavior in this way might be better accomplished by not allowing the element to be focusable at all (see ). + You can override this method in order to change the default focus behavior on your element, but be aware that changing focus behavior in this way might be better accomplished by not allowing the element to be focusable at all (see ). ]]> @@ -4068,7 +4068,7 @@ ## Remarks This particular On* method is not a class handler hook. Nor does it exactly follow the established common language runtime (CLR) On* method convention that the matching event could be suppressed by overriding this method and not calling the base implementation. - Note that the property is read-only, so you cannot set to force initialization behavior. Setting the initialization state is intended to be done only by the Windows Presentation Foundation (WPF) framework. + Note that the property is read-only, so you cannot set to force initialization behavior. Setting the initialization state is intended to be done only by the Windows Presentation Foundation (WPF) framework. ]]> @@ -4160,7 +4160,7 @@ . If you call this method you will reset the property, the property, or both, depending on what is specified as changed in the supplied arguments, and will you always raise the event. + This method overrides . If you call this method you will reset the property, the property, or both, depending on what is specified as changed in the supplied arguments, and will you always raise the event. ]]> @@ -4388,7 +4388,7 @@ The most common usage of this property is an indirect usage within the setter of a style that is supplying a themed style. > [!IMPORTANT] -> If you set to `true` on a control, you will be suppressing the default control template supplied by the theme styles. That control template typically includes the content presenter and other composited elements that provide basic UI functionality and visualization for the control. If you want the control to continue to support the same features as the default theme styles, you must supply an alternate style with a control template that replicates the same structure. For more information, see [Control Authoring Overview](/dotnet/framework/wpf/controls/control-authoring-overview). +> If you set to `true` on a control, you will be suppressing the default control template supplied by the theme styles. That control template typically includes the content presenter and other composited elements that provide basic UI functionality and visualization for the control. If you want the control to continue to support the same features as the default theme styles, you must supply an alternate style with a control template that replicates the same structure. For more information, see [Control Authoring Overview](/dotnet/framework/wpf/controls/control-authoring-overview). ## Dependency Property Information @@ -4396,7 +4396,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -4466,17 +4466,17 @@ may be `null` in cases where an element was instantiated, but is not attached to any logical tree that eventually connects to the page level root element, or the application object. + may be `null` in cases where an element was instantiated, but is not attached to any logical tree that eventually connects to the page level root element, or the application object. Note that the logical parent of an element can potentially change depending on your application's functionality, and keeping the value of this property will not reflect that change. You typically should get the value immediately before you need it. - See [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf) for more information about logical tree traversal, and the scenarios where using as a technique of parent element discovery is appropriate. + See [Trees in WPF](/dotnet/framework/wpf/advanced/trees-in-wpf) for more information about logical tree traversal, and the scenarios where using as a technique of parent element discovery is appropriate. - The property engine will potentially recalculate all property values of an element when it is reparented, because some properties inherit values through the logical tree. The that applies for bindings can also change when elements are reparented. + The property engine will potentially recalculate all property values of an element when it is reparented, because some properties inherit values through the logical tree. The that applies for bindings can also change when elements are reparented. Changing an element's parent is typically only done through manipulation of collections, by using dedicated add or remove methods, or through setting content properties of elements. - The most typical scenario for using the property is to obtain a reference and then get various property values from the parent. For templates, the of the template eventually will be `null`. To get past this point and extend into the logical tree where the template is actually applied, use . + The most typical scenario for using the property is to obtain a reference and then get various property values from the parent. For templates, the of the template eventually will be `null`. To get past this point and extend into the logical tree where the template is actually applied, use . Note that this property does not report visual tree parents in cases where these vary from the logical tree parents. Visual tree parents are not typically important for general application cases but may be the desired parent elements for certain visual level cases. See . @@ -4527,7 +4527,7 @@ or in property metadata during registration, this method is invoked. The method invocation notifies the parent element which particular child element must be re-measured if this element supports partial (incremental) update of layout. + If this element has a child element on which some property was invalidated and the property was marked as or in property metadata during registration, this method is invoked. The method invocation notifies the parent element which particular child element must be re-measured if this element supports partial (incremental) update of layout. By default, does not support incremental layout, and in the class this method has no default implementation. The scenario where overriding this method would be necessary is not common, because it requires you to modify the default layout system behavior. @@ -4571,12 +4571,12 @@ is the related method that actually does move focus. + is the related method that actually does move focus. ## Examples - The following example implements a handler that handles several possible button inputs, each button representing a possible . The handler tracks the element with current keyboard focus, and calls on that element, and specifies the appropriate as initialization for the type parameter provided. Instead of moving to that element as would do, the handler changes the physical dimensions of the predicted focus destination for visualization purposes. + The following example implements a handler that handles several possible button inputs, each button representing a possible . The handler tracks the element with current keyboard focus, and calls on that element, and specifies the appropriate as initialization for the type parameter provided. Instead of moving to that element as would do, the handler changes the physical dimensions of the predicted focus destination for visualization purposes. :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/MoveFocus/Window1.xaml.cs" id="Snippetfepredictfocus"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/MoveFocus/window1.xaml.vb" id="Snippetfepredictfocus"::: @@ -4623,9 +4623,9 @@ . The implementation will check successive parent elements until it finds the applicable implementation, which is found by finding an element that implements . For more information about namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). + This method is a convenience method for calling . The implementation will check successive parent elements until it finds the applicable implementation, which is found by finding an element that implements . For more information about namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). - Calling is necessary in order to correctly hook up animation storyboards for applications when created in code. This is because one of the key storyboard properties, , uses a run-time name lookup instead of being able to take a reference to a target element. This is true even if that element is accessible by reference from the code. For more information on why you need to register names for storyboard targets, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). + Calling is necessary in order to correctly hook up animation storyboards for applications when created in code. This is because one of the key storyboard properties, , uses a run-time name lookup instead of being able to take a reference to a target element. This is true even if that element is accessible by reference from the code. For more information on why you need to register names for storyboard targets, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). @@ -4717,7 +4717,7 @@ (or derived class) that the element that raises the event should be made visible within the scrollable region. The will then mark the event as handled, by using class handling of the event. In general event data should not be marked handled by any class that does control a scrolling region, or by any instance handler, because doing so would interfere with the intended goal of the element that called . + This event indicates to a parent (or derived class) that the element that raises the event should be made visible within the scrollable region. The will then mark the event as handled, by using class handling of the event. In general event data should not be marked handled by any class that does control a scrolling region, or by any instance handler, because doing so would interfere with the intended goal of the element that called . ## Routed Event Information @@ -4875,7 +4875,7 @@ , which passes the current instance as the , and creates a new based on the provided `path` parameter. This signature is more convenient if you are establishing a simple default binding. If you need to specify any binding properties to non-default conditions, or want to use a or ,you should use the signature. + This method is a convenience method for calling , which passes the current instance as the , and creates a new based on the provided `path` parameter. This signature is more convenient if you are establishing a simple default binding. If you need to specify any binding properties to non-default conditions, or want to use a or ,you should use the signature. @@ -4925,7 +4925,7 @@ , which passes the current instance as the . + This method is a convenience method for calling , which passes the current instance as the . ]]> @@ -4966,7 +4966,7 @@ property, therefore allowing child elements of a provided to specify flow direction for the arrangement within their parent element. To set the value on the current , use the direct common language runtime (CLR) accessor . + This method supports attached property syntax for the property, therefore allowing child elements of a provided to specify flow direction for the arrangement within their parent element. To set the value on the current , use the direct common language runtime (CLR) accessor . ]]> @@ -5055,7 +5055,7 @@ . + This will return `true` as long as there is at least one keyed resource in the local . ]]> @@ -5228,7 +5228,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5315,9 +5315,9 @@ ## Remarks For controls, the current style is often provided by a default style from control theming, or from styles generally applied to controls of that type by resources at page or application level (an implicit style). This property does not set or return default (theme) styles, but it does return either an implicit style or an explicit style that is acting on the element. In the case of implicit or explicit styles, it does not matter whether the style is specified as a resource or defined locally. - Setting the styles has some restrictions. You can reset the entire property to a new at any time, which will force a layout recomposition. However, as soon as that style is placed in use by a loaded element, the should be considered sealed. Attempting to make a change to any individual property of an in-use style (such as anything within the collection of ) causes an exception to be thrown. A style that is defined in markup is considered to be in use as soon as it is loaded from a resource dictionary (for resources), or the page it is contained within is loaded (for inline styles). + Setting the styles has some restrictions. You can reset the entire property to a new at any time, which will force a layout recomposition. However, as soon as that style is placed in use by a loaded element, the should be considered sealed. Attempting to make a change to any individual property of an in-use style (such as anything within the collection of ) causes an exception to be thrown. A style that is defined in markup is considered to be in use as soon as it is loaded from a resource dictionary (for resources), or the page it is contained within is loaded (for inline styles). - is a dependency property with special precedence. The locally set style generally operates at the highest precedence in the property system. If the is null at this point, during loading the property system checks for implicit styles in local or application resources that specify that type. If the style is still null after this step, then the acting style for presentation purposes generally comes from the default (theme) style, but the default style is not returned in the property value. See [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence) or [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). + is a dependency property with special precedence. The locally set style generally operates at the highest precedence in the property system. If the is null at this point, during loading the property system checks for implicit styles in local or application resources that specify that type. If the style is still null after this step, then the acting style for presentation purposes generally comes from the default (theme) style, but the default style is not returned in the property value. See [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence) or [Styling and Templating](/dotnet/framework/wpf/controls/styling-and-templating). ## XAML Attribute Usage @@ -5346,7 +5346,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| @@ -5469,7 +5469,7 @@ is intended to provide a pre-existing property location where you can store some basic custom information about any without requiring you to subclass an element. + This property is analogous to Tag properties in other Microsoft programming models, such as Visual Basic for Applications or Windows Forms. is intended to provide a pre-existing property location where you can store some basic custom information about any without requiring you to subclass an element. Because this property takes an object, you need to use the property element usage in order to set the property in XAML to anything other than an object with a known and built-in type converter, such as a string. Objects used in this manner are typically not within the standard WPF namespaces and therefore may require namespace mapping to the external namespace in order to be introduced as XAML elements. For details, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml) and [XAML and Custom Classes for WPF](/dotnet/framework/wpf/advanced/xaml-and-custom-classes-for-wpf). @@ -5595,11 +5595,11 @@ is frequently `null` for objects that are created in your application markup or code. This is because you create those objects directly, not via a template. Object references obtained by walking the logical tree from the root, or by typical name references, do not come from a template. + is frequently `null` for objects that are created in your application markup or code. This is because you create those objects directly, not via a template. Object references obtained by walking the logical tree from the root, or by typical name references, do not come from a template. - Cases where might not be `null` include operations such as hit-testing, event handling for certain low-level input events, walking the visual tree with , or working with enumerators, which might return elements that came from templates. Another case is if you specifically call against an existing and are work with the returned object. + Cases where might not be `null` include operations such as hit-testing, event handling for certain low-level input events, walking the visual tree with , or working with enumerators, which might return elements that came from templates. Another case is if you specifically call against an existing and are work with the returned object. - Templates are actually shared objects, where the contents of the template are created only once. Therefore, if you obtain an object reference to an element that came from a template, you may find that the apparent logical tree does not reach to the page root. In order to connect such a template reference to the page's logical tree, you should get the value and continue to navigate that element tree as desired. + Templates are actually shared objects, where the contents of the template are created only once. Therefore, if you obtain an object reference to an element that came from a template, you may find that the apparent logical tree does not reach to the page root. In order to connect such a template reference to the page's logical tree, you should get the value and continue to navigate that element tree as desired. ]]> @@ -5682,10 +5682,10 @@ ## XAML Values *toolTipContent* - A string that becomes the display text for the . + A string that becomes the display text for the . *toolTipObjectContent* - Some object, provided in object element form, that should be used as the content for the . Typically this would be a or some other element that creates layout compositing for the , eventually containing text content within the compositing. In this usage, the element is created implicitly from the parsed XAML, and the *toolTipObjectContent* content is set as its property. + Some object, provided in object element form, that should be used as the content for the . Typically this would be a or some other element that creates layout compositing for the , eventually containing text content within the compositing. In this usage, the element is created implicitly from the parsed XAML, and the *toolTipObjectContent* content is set as its property. <`ToolTip` .../> See . @@ -5752,7 +5752,7 @@ |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -5790,7 +5790,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5827,7 +5827,7 @@ ## Remarks To prevent a tooltip from appearing in the UI, your handler for can mark the event data handled. Otherwise, the tooltip is displayed, using the value of the property as the tooltip content. Another possible scenario is that you could write a handler that resets the value of the property for the element that is the event source, just before the tooltip is displayed. - will not be raised if the value of is `null` or otherwise unset. Do not deliberately set to `null` while a tooltip is open or opening; this will not have the effect of closing the tooltip, and will instead create an undesirable visual artifact in the UI. + will not be raised if the value of is `null` or otherwise unset. Do not deliberately set to `null` while a tooltip is open or opening; this will not have the effect of closing the tooltip, and will instead create an undesirable visual artifact in the UI. The event cannot be an in a style. This is because the identifier field of this event re-uses an implementation from a service that does not expose add/remove event methods for the service-level event. @@ -5840,7 +5840,7 @@ |Routing strategy|Direct| |Delegate|| -- Override to implement class handling for this event in derived classes. +- Override to implement class handling for this event in derived classes. ]]> @@ -5878,7 +5878,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -5954,7 +5954,7 @@ This property does not enable you to examine triggers that exist as part of styles in use on this element. It only reports the collection of triggers that are literally added to the collection, either in markup or code. Elements do not typically have such elements existing by default (through a template for instance); it is more common for triggers that come from control compositing to be established in styles instead. - In terms of behavior (and trying to establish which effect came from which element's declared collection), both the triggering condition and the trigger effect might be on this element, or might be on its child elements in the logical tree. Note that if you use lifetime events such as to get this collection, the child element's triggers might not yet be fully loaded, and the collection will be smaller than it would truly be at run time. + In terms of behavior (and trying to establish which effect came from which element's declared collection), both the triggering condition and the trigger effect might be on this element, or might be on its child elements in the logical tree. Note that if you use lifetime events such as to get this collection, the child element's triggers might not yet be fully loaded, and the collection will be smaller than it would truly be at run time. Note that the collection of triggers established on an element only supports , not property triggers (). If you require property triggers, you must place these within a style or template and then assign that style or template to the element either directly through the property, or indirectly through an implicit style reference. @@ -6013,16 +6013,16 @@ is called. + If the resource is not found on the calling element, the parent resource tree is searched upward through the logical tree, in the same way that the tree would be searched if a resource were requested by key at run time. The method returns `null` only if no resource of that key existed anywhere in the resource tree, per the existing conditions of the tree at the time that is called. Typically you would immediately cast the return value to the type of the property that you were attempting to set with the returned resource value. - The method has similar behavior, except that it throws an exception if no resource with the provided key was returned. + The method has similar behavior, except that it throws an exception if no resource with the provided key was returned. ## Examples - The following example is implemented as a button handler, where the button being clicked sets its background to a resource-defined brush obtained by calling on itself. This walks the element tree and finds the resource (the resource itself is defined in XAML and is not shown). + The following example is implemented as a button handler, where the button being clicked sets its background to a resource-defined brush obtained by calling on itself. This walks the element tree and finds the resource (the resource itself is defined in XAML and is not shown). :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/BringIntoView/Page1.xaml.cs" id="Snippetfetryfindresource"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/BringIntoView/page1.xaml.vb" id="Snippetfetryfindresource"::: @@ -6112,7 +6112,7 @@ ## Remarks Routed event identifiers are created when routed events are registered. These identifiers contain an identifying name, owner type, handler type, routing strategy, and utility method for adding owners for the event. You can use these identifiers to add class handlers. - For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . + For more information about registering routed events, see . For more information about using routed event identifiers to add class handlers, see . ]]> @@ -6217,12 +6217,12 @@ property for an element is `true`, all non-integral pixel values that are calculated during the and passes are rounded to whole pixel values. + When the property for an element is `true`, all non-integral pixel values that are calculated during the and passes are rounded to whole pixel values. This property is inherited by child elements. > [!NOTE] -> You should set to `true` on the root element. The layout system adds child coordinates to the parent coordinates; therefore, if the parent coordinates are not on a pixel boundary, the child coordinates are also not on a pixel boundary. If cannot be set at the root, set on the child to obtain the effect that you want. +> You should set to `true` on the root element. The layout system adds child coordinates to the parent coordinates; therefore, if the parent coordinates are not on a pixel boundary, the child coordinates are also not on a pixel boundary. If cannot be set at the root, set on the child to obtain the effect that you want. Drawing objects on pixel boundaries eliminates the semi-transparent edges that are produced by anti-aliasing, when an edge falls in the middle of a device pixel. The following illustration shows the output of a single pixel-width line that falls in the middle of a device pixel. The line on the left does not use layout rounding and is anti-aliased. The line on the right uses layout rounding. @@ -6332,11 +6332,11 @@ and properties are explicitly set on an element, these measurements take layout precedent and cancel the regular effects of setting this property to . + When and properties are explicitly set on an element, these measurements take layout precedent and cancel the regular effects of setting this property to . - is the Microsoft .NET property accessor for what is in reality a dependency property. This particular dependency property quite frequently has its apparent "default" value set differently in derived element classes, particularly controls. This generally occurs in one of two ways: the dependency property is re-registered to a particular derived class, but with different metadata for setting its defaults; or there is a default style being applied that sets that dependency property value differently. For example, the apparent "default" of for a control will be , even though inherits direct from . This is because that value was reset within the default style of , within the style's control template. + is the Microsoft .NET property accessor for what is in reality a dependency property. This particular dependency property quite frequently has its apparent "default" value set differently in derived element classes, particularly controls. This generally occurs in one of two ways: the dependency property is re-registered to a particular derived class, but with different metadata for setting its defaults; or there is a default style being applied that sets that dependency property value differently. For example, the apparent "default" of for a control will be , even though inherits direct from . This is because that value was reset within the default style of , within the style's control template. - does not use when composing layout, because is based on absolute positioning. + does not use when composing layout, because is based on absolute positioning. When inherited by or any derived classes, redefines the default value of this property to be . @@ -6346,7 +6346,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> @@ -6410,14 +6410,14 @@ implementation of always returns either zero or one. Classes that maintain a visual child collection that might exceed one must override both this property and . + The implementation of always returns either zero or one. Classes that maintain a visual child collection that might exceed one must override both this property and . - This property is generally used to determine the upper bounds of the current child collection for purposes of implementing the layout overrides (, ). + This property is generally used to determine the upper bounds of the current child collection for purposes of implementing the layout overrides (, ). ## Examples - The following example shows how a custom adorner uses the values declared by a that it maintains for its multiple visual children and reports these values through overrides of and . + The following example shows how a custom adorner uses the values declared by a that it maintains for its multiple visual children and reports these values through overrides of and . :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkElement/GetVisualChild/ResizingAdorner.cs" id="Snippetfevisualoverridespre"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/FrameworkElement/GetVisualChild/resizingadorner.vb" id="Snippetfevisualoverridespre"::: @@ -6471,13 +6471,13 @@ that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . + This is one of three properties on that specify width information. The other two are and . If there is a conflict between these values, the order of application for actual width determination is first must be honored, then , and finally if each of these are within bounds, . - The return value of this property is always the same as any value that was set to it. In contrast, the value of the may vary. The layout may have rejected the suggested size for some reason. Also, the layout system itself works asynchronously relative to the property system set of and may not have processed that particular sizing property change yet. + The return value of this property is always the same as any value that was set to it. In contrast, the value of the may vary. The layout may have rejected the suggested size for some reason. Also, the layout system itself works asynchronously relative to the property system set of and may not have processed that particular sizing property change yet. In addition to acceptable values, this property can also be . This is how you specify auto sizing behavior. In XAML you set the value to the string "Auto" (case insensitive) to enable the auto sizing behavior. Auto sizing behavior implies that the element will fill the width available to it. Note however that specific controls frequently supply default values in their default styles that will disable the auto sizing behavior unless it is specifically re-enabled. - In addition to the validation check, there is a nondeterministic upper value bound for that is enforced by the layout system (this is a very large number, larger than but smaller than ). If you exceed this bound, the element will not render, and no exception is thrown. Do not set to a value that is significantly larger than the maximum size of any possible visual display, or you may exceed this nondeterministic upper bound. + In addition to the validation check, there is a nondeterministic upper value bound for that is enforced by the layout system (this is a very large number, larger than but smaller than ). If you exceed this bound, the element will not render, and no exception is thrown. Do not set to a value that is significantly larger than the maximum size of any possible visual display, or you may exceed this nondeterministic upper bound. ## XAML Attribute Usage @@ -6525,7 +6525,7 @@ | Item | Value | |-----------------------------------|--------------------------------------------------------| |Identifier field|| -|Metadata properties set to `true`|| +|Metadata properties set to `true`|| ]]> diff --git a/xml/System.Windows/FrameworkElementFactory.xml b/xml/System.Windows/FrameworkElementFactory.xml index 7111a0cb13a..f67baf9b410 100644 --- a/xml/System.Windows/FrameworkElementFactory.xml +++ b/xml/System.Windows/FrameworkElementFactory.xml @@ -30,11 +30,11 @@ Supports the creation of templates. - such as or ; not all of the template functionality is available when you create a template using this class. The recommended way to programmatically create a template is to load XAML from a string or a memory stream using the method of the class. - + such as or ; not all of the template functionality is available when you create a template using this class. The recommended way to programmatically create a template is to load XAML from a string or a memory stream using the method of the class. + ]]> diff --git a/xml/System.Windows/FrameworkPropertyMetadata.xml b/xml/System.Windows/FrameworkPropertyMetadata.xml index 8d293b52ae2..259ad31edac 100644 --- a/xml/System.Windows/FrameworkPropertyMetadata.xml +++ b/xml/System.Windows/FrameworkPropertyMetadata.xml @@ -88,7 +88,7 @@ to their property defaults. will be `null`, and the various Boolean properties will be `false`. + This signature initializes all values of to their property defaults. will be `null`, and the various Boolean properties will be `false`. ]]> @@ -656,11 +656,11 @@ and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element (a call to ). Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. + and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element (a call to ). Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. - Custom implementations might choose to have similar behavior for dependency property changes where is `true`. + Custom implementations might choose to have similar behavior for dependency property changes where is `true`. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -713,11 +713,11 @@ and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. + and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. - Custom implementations might choose to have similar behavior for dependency property changes where is `true`. + Custom implementations might choose to have similar behavior for dependency property changes where is `true`. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -771,15 +771,15 @@ and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for the parent element. + and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for the parent element. - Generally, you do not need to report changes of a property to a parent element using because the element itself would already have its own as `true`. That is usually sufficient, because changes in the child element generally initiate a parent arrange when appropriate. is sometimes used for a derived class. In this case, the child element sets a property, but a derived class does not control its own rendering. The rendering is handled by a parent element that serves as the content host. For instance, a change to the value of the attached property by a child element invalidates arrange of the parent, because the position of the child in the parent must be changed. Therefore, the attached property has metadata where is `true`. Another example is ; when this property changes, the parent might change the positioning of the child, depending on available space. + Generally, you do not need to report changes of a property to a parent element using because the element itself would already have its own as `true`. That is usually sufficient, because changes in the child element generally initiate a parent arrange when appropriate. is sometimes used for a derived class. In this case, the child element sets a property, but a derived class does not control its own rendering. The rendering is handled by a parent element that serves as the content host. For instance, a change to the value of the attached property by a child element invalidates arrange of the parent, because the position of the child in the parent must be changed. Therefore, the attached property has metadata where is `true`. Another example is ; when this property changes, the parent might change the positioning of the child, depending on available space. - Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. + Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. - Custom implementations might choose to have similar behavior for dependency property changes where is `true`. + Custom implementations might choose to have similar behavior for dependency property changes where is `true`. - Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -822,15 +822,15 @@ and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for the parent element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. + and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for the parent element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. - Generally, you do not need to report changes of a property to a parent element using because the element itself would already have its own as `true`. That is usually sufficient, because changes in the child element generally initiate a parent measure pass when appropriate. is sometimes used for a derived class. In this case, the child element sets a property, but a derived class does not control its own rendering. The rendering is handled by a parent element that serves as the content host. For instance, a change to the value of the property by a child element invalidates measure of the parent, because the relative spacing of paragraphs might change and might increase or decrease the content host size. Therefore, the property has metadata where is `true`. + Generally, you do not need to report changes of a property to a parent element using because the element itself would already have its own as `true`. That is usually sufficient, because changes in the child element generally initiate a parent measure pass when appropriate. is sometimes used for a derived class. In this case, the child element sets a property, but a derived class does not control its own rendering. The rendering is handled by a parent element that serves as the content host. For instance, a change to the value of the property by a child element invalidates measure of the parent, because the relative spacing of paragraphs might change and might increase or decrease the content host size. Therefore, the property has metadata where is `true`. - Content host elements also frequently look for changes in dependency properties where is `true`, as part of content host rendering logic. For instance, the element must respond to certain changes within text that might require that the bounding box of the itself be changed. + Content host elements also frequently look for changes in dependency properties where is `true`, as part of content host rendering logic. For instance, the element must respond to certain changes within text that might require that the bounding box of the itself be changed. - Custom implementations might choose to have similar behavior for dependency property changes where is `true`. + Custom implementations might choose to have similar behavior for dependency property changes where is `true`. - Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -873,11 +873,11 @@ and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. + and include an implementation of that monitors effective value changes to all dependency properties that exist on an element. As part of that logic, dependency properties that change effective value and have metadata with set to `true` will initiate a deferred request to invalidate the visuals for that element. Because this WPF framework-level implementation is already in place, you typically do not need to look for dependency properties with unless you are substantially replacing or modifying the WPF framework-level layout behavior. - Custom implementations might choose to have similar behavior for dependency property changes where is `true`. + Custom implementations might choose to have similar behavior for dependency property changes where is `true`. - Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -932,11 +932,11 @@ ## Remarks In absence of this property being `true`, binding updates are one-way by default, based on the default behavior of the constructors or equivalent XAML syntax. - In existing elements, you will usually find this property set to `true` in metadata for dependency properties that both report state and are modifiable by user action, for example . + In existing elements, you will usually find this property set to `true` in metadata for dependency properties that both report state and are modifiable by user action, for example . This property only reports the default binding update characteristics of the dependency property in general. Any binding set to this property on an instance can locally set the property of the binding and change this default. - Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on any derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -988,7 +988,7 @@ are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -1034,9 +1034,9 @@ Property value inheritance is a feature of the WPF property system at the WPF framework level, whereby certain dependency properties can be locally set on an element at or near the root of a XAML element tree and then have their value inherited by all elements within the logical tree of child elements that also possess that property. Property value inheritance is not enabled by default, and enabling it does have some performance implications. For details, see [Property Value Inheritance](/dotnet/framework/wpf/advanced/property-value-inheritance). > [!NOTE] -> Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain object-object divisions in the runtime tree is undefined. Always use to register properties where you specify in the metadata. +> Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain object-object divisions in the runtime tree is undefined. Always use to register properties where you specify in the metadata. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -1089,9 +1089,9 @@ , is set to `true` in this metadata. This property is exposed as a convenience so that callers do not have to check both and . + This property reports `false` for one of two possible conditions: either data binding to a dependency property is not allowed because the dependency property is read-only (as reported in the dependency property identifier, not the metadata), or the value of another metadata property, , is set to `true` in this metadata. This property is exposed as a convenience so that callers do not have to check both and . - If you are attempting to create metadata that specifies that an otherwise read/write property should not support data binding, specify the flag (note the slight naming convention difference versus ). + If you are attempting to create metadata that specifies that an otherwise read/write property should not support data binding, specify the flag (note the slight naming convention difference versus ). ## XAML Text Usage @@ -1143,11 +1143,11 @@ , this does not merely change a default that can later be changed on a specific binding. Setting this property `true` in the metadata for a dependency property metadata will disable all bindings from applying their values through expressions to that dependency property. + Note that this metadata property is set to `true` specifically for properties that should not support data binding, despite being read-write properties. The expectation is that in most cases where a dependency property is declared, data binding is desired, because data binding is one of the key scenarios where a dependency property is useful. Unlike , this does not merely change a default that can later be changed on a specific binding. Setting this property `true` in the metadata for a dependency property metadata will disable all bindings from applying their values through expressions to that dependency property. - Read-only dependency properties do not support data binding (because they have no setter that can apply changed values), but will still report `false` for . This is because properties that correspond to a values will report parity with how the metadata was actually established, rather than always reporting the end result behavior that the naming of the property might imply. To determine whether a given dependency property permits data binding, you should usually check instead. is a convenience for checking both and as a single operation, yielding the expected result. + Read-only dependency properties do not support data binding (because they have no setter that can apply changed values), but will still report `false` for . This is because properties that correspond to a values will report parity with how the metadata was actually established, rather than always reporting the end result behavior that the naming of the property might imply. To determine whether a given dependency property permits data binding, you should usually check instead. is a convenience for checking both and as a single operation, yielding the expected result. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -1191,7 +1191,7 @@ are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -1335,9 +1335,9 @@ , where the content might get reloaded independently of the existence of the . The desired property system behavior is that property value inheritance should not traverse into the contents of the , because these contents might be elements that the application hosting the frame does not own or control. Specifying metadata with set to `true`, as well as specifying as `true`, will cause the property on which the metadata is applied to be inheritable even across the boundary or similar boundaries. + This metadata reports a seldom-applied modification to property value inheritance behavior across special parent element-child element boundaries. The canonical example of such a boundary is the contents of a , where the content might get reloaded independently of the existence of the . The desired property system behavior is that property value inheritance should not traverse into the contents of the , because these contents might be elements that the application hosting the frame does not own or control. Specifying metadata with set to `true`, as well as specifying as `true`, will cause the property on which the metadata is applied to be inheritable even across the boundary or similar boundaries. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, after the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage @@ -1382,7 +1382,7 @@ ## Remarks This metadata option is pertinent for dependency properties that are reference types, where that type has property values of its own. Typically, the layout system logic is to assume that any dependency property with sub-properties potentially will affect layout, because checking all sub-properties for changes is more time consuming than actually running another render pass. Setting this option to `true` is useful for optimizing performance of the WPF framework level layout system implementation. - Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. + Properties on derived classes of are typically defined in the object model as read-write. This is so they can be adjusted after initialization of the instance. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and properties that convey the specifics of the metadata are now considered immutable. Attempting to set this property after is `true` on this metadata instance will raise an exception. ## XAML Text Usage diff --git a/xml/System.Windows/FrameworkPropertyMetadataOptions.xml b/xml/System.Windows/FrameworkPropertyMetadataOptions.xml index 67a3c0f770a..e075fa95776 100644 --- a/xml/System.Windows/FrameworkPropertyMetadataOptions.xml +++ b/xml/System.Windows/FrameworkPropertyMetadataOptions.xml @@ -29,25 +29,25 @@ Specifies the types of framework-level property behavior that pertain to a particular dependency property in the Windows Presentation Foundation (WPF) property system. - instance, and you want to specify one or more the framework-level metadata option settings. - - You no longer use this enumeration after the constructor call. Instead, query the particular metadata option that was set during registration by checking the `true` or `false` value of a specific property of an existing . These property names match the `FrameworkPropertyMetadataOptions` enumeration values except for NotDataBindable, which is on the finished . - - The `Journal` option only specifies the intention to be journaled. The actual journaling may or may not be addressed by journaling services such as those that are present in the WPF viewer application. In particular, journaling has some known limitations if the element tree was constructed through code rather than XAML. For details, see [Navigation Overview](/dotnet/framework/wpf/app-development/navigation-overview). - + instance, and you want to specify one or more the framework-level metadata option settings. + + You no longer use this enumeration after the constructor call. Instead, query the particular metadata option that was set during registration by checking the `true` or `false` value of a specific property of an existing . These property names match the `FrameworkPropertyMetadataOptions` enumeration values except for NotDataBindable, which is on the finished . + + The `Journal` option only specifies the intention to be journaled. The actual journaling may or may not be addressed by journaling services such as those that are present in the WPF viewer application. In particular, journaling has some known limitations if the element tree was constructed through code rather than XAML. For details, see [Navigation Overview](/dotnet/framework/wpf/app-development/navigation-overview). + > [!NOTE] -> Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Always use the method to register properties where you specify in the metadata. - - - -## Examples +> Although property value inheritance might appear to work for nonattached dependency properties, the inheritance behavior for a nonattached property through certain element boundaries in the runtime tree is undefined. Always use the method to register properties where you specify in the metadata. + + + +## Examples The following example calls the constructor and sets several options by using values from the `FrameworkPropertyMetadataOptions` enumeration: - - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetfpmctor_dv_fpmo_pcc_cvc"::: - + + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetfpmctor_dv_fpmo_pcc_cvc"::: + ]]> diff --git a/xml/System.Windows/Freezable.xml b/xml/System.Windows/Freezable.xml index 98603f53dc2..9771cd6aece 100644 --- a/xml/System.Windows/Freezable.xml +++ b/xml/System.Windows/Freezable.xml @@ -199,9 +199,9 @@ and methods produce modifiable clones of frozen objects (the methods also clone objects that are not frozen). The clone is effectively a deep copy of the current object. + The and methods produce modifiable clones of frozen objects (the methods also clone objects that are not frozen). The clone is effectively a deep copy of the current object. - The following table summarizes the differences between the and methods. + The following table summarizes the differences between the and methods. |Action|Clone method behavior|CloneCurrentValue method behavior| |------------|---------------------------|---------------------------------------| @@ -211,7 +211,7 @@ Note that unset properties are not copied. If an unset property has a default value that is a frozen , that property value remains frozen in the otherwise modifiable clone. ## Move a Freezable Between Threads - This method can be useful for moving a between threads. First, make the unmodifiable by calling its method. Now another thread can access the and make a local that it can access. + This method can be useful for moving a between threads. First, make the unmodifiable by calling its method. Now another thread can access the and make a local that it can access. ]]> @@ -261,7 +261,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. ]]> @@ -330,9 +330,9 @@ and methods produce modifiable clones of frozen objects (the methods also clone objects that are not frozen). The clone is effectively a deep copy of the current object. + The and methods produce modifiable clones of frozen objects (the methods also clone objects that are not frozen). The clone is effectively a deep copy of the current object. - The following table summarizes the differences between the and methods. + The following table summarizes the differences between the and methods. |Action|Clone method behavior|CloneCurrentValue method behavior| |------------|---------------------------|---------------------------------------| @@ -342,7 +342,7 @@ Note that unset properties are not copied. If an unset property has a default value that is a frozen , that property value remains frozen in the otherwise modifiable clone. ## Move a Freezable Between Threads - This method can be useful for moving a between threads. First, make the unmodifiable by using its method. Now another thread can access the and make a local clone that it can access. + This method can be useful for moving a between threads. First, make the unmodifiable by using its method. Now another thread can access the and make a local clone that it can access. ]]> @@ -391,7 +391,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. ]]> @@ -456,7 +456,7 @@ method, which this method calls internally. + This is a protected method, and the actual object-specific implementations for the behavior are dependent on the override implementation of the method, which this method calls internally. ]]> @@ -494,12 +494,12 @@ method whenever a new instance of the is created. + Do not call this method directly (except when calling base in an implementation). This method is called internally by the method whenever a new instance of the is created. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -599,7 +599,7 @@ and overriding the method. This method may be used in the method to freeze class data members that are themselves objects. + Do not call this method unless you are deriving from and overriding the method. This method may be used in the method to freeze class data members that are themselves objects. It is alright to call this method again on a object that is already frozen (unmodifiable). @@ -647,7 +647,7 @@ property (with `isChecking` equal to `true`) and the method (with `isChecking` equal to `false`). + Do not call this method directly (except when calling base in an implementation). This method is called internally by the property (with `isChecking` equal to `true`) and the method (with `isChecking` equal to `false`). ]]> @@ -692,20 +692,20 @@ property before calling this method to verify that the can be frozen. Using this method is similar to creating a copy using the and then freezing it with the method. + You should check the property before calling this method to verify that the can be frozen. Using this method is similar to creating a copy using the and then freezing it with the method. - The and methods can improve copying performance because they do not clone sub-objects that are already frozen; they only copy them by reference. + The and methods can improve copying performance because they do not clone sub-objects that are already frozen; they only copy them by reference. - The following table summarizes the differences between the and methods. + The following table summarizes the differences between the and methods. |Action|GetAsFrozen method behavior|GetCurrentValueAsFrozen method behavior| |------------|---------------------------------|---------------------------------------------| -|Copying a dependency property that has an expression|The method throws an because it cannot the property.|The current value of the expression is copied, but not the expression itself.| +|Copying a dependency property that has an expression|The method throws an because it cannot the property.|The current value of the expression is copied, but not the expression itself.| |Copying an animated dependency property|The property's base (non-animated) value is copied. Animations are not copied.|The property's current animated value is copied. Animations are not copied.| Note that unset properties are not copied, nor are read-only properties. - To create a copy of the that is not frozen, use the method. + To create a copy of the that is not frozen, use the method. ]]> @@ -755,7 +755,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. ]]> @@ -810,20 +810,20 @@ and then freezing it with the method. + Using this method is similar to creating a copy using the and then freezing it with the method. - The and methods can improve copying performance because they do not clone sub-objects that are already frozen; they only copy them by reference. + The and methods can improve copying performance because they do not clone sub-objects that are already frozen; they only copy them by reference. - The following table summarizes the differences between the and methods. + The following table summarizes the differences between the and methods. |Action|GetAsFrozen method behavior|GetCurrentValueAsFrozen method behavior| |------------|---------------------------------|---------------------------------------------| -|Copying a dependency property that has an expression|The method throws an because it cannot the property.|The current value of the expression is copied, but not the expression itself.| +|Copying a dependency property that has an expression|The method throws an because it cannot the property.|The current value of the expression is copied, but not the expression itself.| |Copying an animated dependency property|The property's base (non-animated) value is copied. Animations are not copied.|The property's current animated value is copied. Animations are not copied.| Note that unset properties are not copied, nor are read-only properties. - To create a copy of the that is not frozen, use the method. + To create a copy of the that is not frozen, use the method. ]]> @@ -873,7 +873,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. ]]> @@ -930,7 +930,7 @@ ## Remarks Attempting to modify an object when its property is `true` throws an . - This property is read-only from the object model perspective. Some of the documentation about behaviors may mention "sets to `true`" or similar language when discussing the behavior of other methods of , but this behavior is happening internally in the class instances, when methods of the instance manipulate the private variables that exist within the abstract class. To set the value of this property, you should call . This effectively is a one-time operation to change the property from the initial default `false` state to the `true` state. There is no available means to set the value back to `false`. Instead, you could change any deep copy made from the original (see the method). This is by design and is how any derived class should behave when applied to the cases where the pattern is useful. + This property is read-only from the object model perspective. Some of the documentation about behaviors may mention "sets to `true`" or similar language when discussing the behavior of other methods of , but this behavior is happening internally in the class instances, when methods of the instance manipulate the private variables that exist within the abstract class. To set the value of this property, you should call . This effectively is a one-time operation to change the property from the initial default `false` state to the `true` state. There is no available means to set the value back to `false`. Instead, you could change any deep copy made from the original (see the method). This is by design and is how any derived class should behave when applied to the cases where the pattern is useful. ]]> @@ -1212,7 +1212,7 @@ to verify the threading context is accessible, and it throws an exception if the instance is already frozen. + This method calls to verify the threading context is accessible, and it throws an exception if the instance is already frozen. ]]> diff --git a/xml/System.Windows/FreezableCollection`1.xml b/xml/System.Windows/FreezableCollection`1.xml index 3df6cd0d740..f42d47d713c 100644 --- a/xml/System.Windows/FreezableCollection`1.xml +++ b/xml/System.Windows/FreezableCollection`1.xml @@ -65,13 +65,13 @@ This class is provided to enable the creation of custom collection types that fully support data binding, change notification, property invalidation, and animation of its contents. ### XAML Usage for FreezableCollection - supports a limited XAML syntax. + supports a limited XAML syntax. -- As an object element at the root, you can theoretically specify an unconstrained object element, which must also specify the [x:TypeArguments Directive](/dotnet/framework/xaml-services/x-typearguments-directive) to declare the constraint. However, this is not a common scenario, because to do this, the must be the root element. This limitation exists because the XAML processor implementation in WPF can only support [x:TypeArguments Directive](/dotnet/framework/xaml-services/x-typearguments-directive) when the element it is being set on is the root element, and you must use on any open constraint generic if you want to instantiate a generic type in XAML. It is unlikely that you want a as the root element, even as loose XAML. +- As an object element at the root, you can theoretically specify an unconstrained object element, which must also specify the [x:TypeArguments Directive](/dotnet/framework/xaml-services/x-typearguments-directive) to declare the constraint. However, this is not a common scenario, because to do this, the must be the root element. This limitation exists because the XAML processor implementation in WPF can only support [x:TypeArguments Directive](/dotnet/framework/xaml-services/x-typearguments-directive) when the element it is being set on is the root element, and you must use on any open constraint generic if you want to instantiate a generic type in XAML. It is unlikely that you want a as the root element, even as loose XAML. -- If you derive from and apply a type constraint in the derived collection, the derived collection can support a variety of usages. This is possible because the constraint in your derivation eliminates the need to pass . +- If you derive from and apply a type constraint in the derived collection, the derived collection can support a variety of usages. This is possible because the constraint in your derivation eliminates the need to pass . - - The typical XAML usage for such a derived collection is through implicit collection syntax. Collections that support certain interfaces do not need to specify the collection itself as an object element. For details on collection syntax in XAML, see [XAML Syntax In Detail](/dotnet/framework/wpf/advanced/xaml-syntax-in-detail). For instance, an *object* with a *property* where the *property* was of type constrained by could support the following syntax: + - The typical XAML usage for such a derived collection is through implicit collection syntax. Collections that support certain interfaces do not need to specify the collection itself as an object element. For details on collection syntax in XAML, see [XAML Syntax In Detail](/dotnet/framework/wpf/advanced/xaml-syntax-in-detail). For instance, an *object* with a *property* where the *property* was of type constrained by could support the following syntax: ``` @@ -153,9 +153,9 @@ also modifies that element for `collection`. + This operation performs a shallow copy on the specified collection; only references to the collection's elements are copied, the elements themselves are not cloned. Modifying an element of the new also modifies that element for `collection`. - The elements are placed in the new in the same order they are read by the enumerator of the specified collection. + The elements are placed in the new in the same order they are read by the enumerator of the specified collection. ]]> @@ -296,7 +296,7 @@ method with a strongly typed implementation for convenience. + This method shadows the inherited method with a strongly typed implementation for convenience. ]]> @@ -336,7 +336,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. ]]> @@ -377,7 +377,7 @@ method with a strongly typed implementation for convenience. + This method shadows the inherited method with a strongly typed implementation for convenience. ]]> @@ -417,7 +417,7 @@ method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. + This method is called by the method and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a modifiable copy of the current object, call instead of calling this method directly. ]]> @@ -502,7 +502,7 @@ . + Note that this operation performs a shallow copy. The elements are copied to the target array in the same order in which the enumerator iterates through this . ]]> @@ -577,12 +577,12 @@ , whenever a new instance of the is created. + Do not call this method directly (except when calling base in an implementation). This method is called internally by , whenever a new instance of the is created. ## Examples - The following example shows a typical implementation of . + The following example shows a typical implementation of . :::code language="csharp" source="~/snippets/csharp/System.Windows/Freezable/CreateInstanceCore/freezablesample.cs" id="Snippetcreateinstancecoreexample"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/freezablesample_procedural/visualbasic/freezablesample.vb" id="Snippetcreateinstancecoreexample"::: @@ -632,7 +632,7 @@ (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). + Do not call this method directly (except when calling base in an implementation). This method is called internally by (with `isChecking` equal to `true`) and (with `isChecking` equal to `false`). ]]> @@ -675,7 +675,7 @@ and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. ]]> @@ -718,7 +718,7 @@ and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. + This method is called by and should not be called directly from your code, except when calling the base implementation while overriding this method. To create a frozen copy of the current object, call instead of calling this method directly. ]]> @@ -999,7 +999,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1039,7 +1039,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1084,7 +1084,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1125,7 +1125,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1164,7 +1164,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1204,7 +1204,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1248,7 +1248,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1293,7 +1293,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1337,7 +1337,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1382,7 +1382,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1423,7 +1423,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1463,7 +1463,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1506,7 +1506,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1549,7 +1549,7 @@ instance is cast to an interface. + This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1587,7 +1587,7 @@ instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1624,7 +1624,7 @@ This member is an explicit interface member implementation. It can be used only instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Windows/GridLength.xml b/xml/System.Windows/GridLength.xml index afe043c79a5..2ec97aa6f61 100644 --- a/xml/System.Windows/GridLength.xml +++ b/xml/System.Windows/GridLength.xml @@ -402,7 +402,7 @@ value is . Therefore, this property returns `true` if you do not specify a when creating the instance. + The default value is . Therefore, this property returns `true` if you do not specify a when creating the instance. ]]> diff --git a/xml/System.Windows/HierarchicalDataTemplate.xml b/xml/System.Windows/HierarchicalDataTemplate.xml index e381c568a15..f5041665a05 100644 --- a/xml/System.Windows/HierarchicalDataTemplate.xml +++ b/xml/System.Windows/HierarchicalDataTemplate.xml @@ -157,9 +157,9 @@ and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. + The and properties enable you to specify the appearance for two or more alternating item containers. For example, you can specify alternating background colors for every third item in an . The is assigned to each item container in the . begins at 0, increments until it is minus 1, and then restarts at 0. For example, if is 3 and there are seven items in the , the following table lists the for each item. -|Position of Item in the || +|Position of Item in the || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| |1|0| |2|1| @@ -169,16 +169,16 @@ |6|2| |7|0| - When you set the property, you are indicating that the child items should get an in that range, not the item that has this applied to it. For example, if a called `aHeaderedItemsControl` uses a with the set, the item containers of the child items of `aHeaderedItemsControl` will have an , not the item container for `aHeaderedItemsControl`. + When you set the property, you are indicating that the child items should get an in that range, not the item that has this applied to it. For example, if a called `aHeaderedItemsControl` uses a with the set, the item containers of the child items of `aHeaderedItemsControl` will have an , not the item container for `aHeaderedItemsControl`. - There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . + There are several methods you can use to specify different appearances for the alternating item containers. One method is to bind properties of the items container to the . You can then use an to specify which value should be applied to the item container that has a certain value. You can also use triggers to change the value of an item container's property depending on the value of its . ## Examples The following example creates a that is bound to data that is three levels deep, and each item is displayed in a . The objects in the first level have the same property values, the objects in the second level use alternating values for the property, and the objects in the third level use alternating values for the property. - Because the for the first level, `Level1Data`, has the property set to 2, the for the objects in the second level alternates between 0 and 1. In the for the second level, `Level2Data`, the of the is bound to the and an is provided to convert the to an alternating . A similar relationship exists between `Level2Data` and `Level3Data`: The is set to 3 on `Level2Data`, and the in `Level3Ddata` has its property bound to the . + Because the for the first level, `Level1Data`, has the property set to 2, the for the objects in the second level alternates between 0 and 1. In the for the second level, `Level2Data`, the of the is bound to the and an is provided to convert the to an alternating . A similar relationship exists between `Level2Data` and `Level3Data`: The is set to 3 on `Level2Data`, and the in `Level3Ddata` has its property bound to the . :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/AlternationCount/Window1.xaml" id="Snippet5"::: @@ -222,7 +222,7 @@ property, each item container gets a that has the same objects as the , but the properties that describe the data in the bindings, such as and , are specific to the data for each item in the . You must access the item container's to perform operations such as validate the data and check for errors on an item. + When you set the property, each item container gets a that has the same objects as the , but the properties that describe the data in the bindings, such as and , are specific to the data for each item in the . You must access the item container's to perform operations such as validate the data and check for errors on an item. ]]> @@ -323,7 +323,7 @@ ## Examples - The following example creates a that uses the of a to choose between two styles for items in the second level of the . + The following example creates a that uses the of a to choose between two styles for items in the second level of the . :::code language="xaml" source="~/snippets/csharp/System.Windows/HierarchicalDataTemplate/ItemContainerStyle/Window1.xaml" id="Snippetitemcontainerstyleselector"::: diff --git a/xml/System.Windows/HorizontalAlignment.xml b/xml/System.Windows/HorizontalAlignment.xml index cac4f4d9b12..6127f3a9c29 100644 --- a/xml/System.Windows/HorizontalAlignment.xml +++ b/xml/System.Windows/HorizontalAlignment.xml @@ -29,13 +29,13 @@ Indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element. - and properties that are explicitly set take precedence over the Stretch property value. - + and properties that are explicitly set take precedence over the Stretch property value. + ]]> diff --git a/xml/System.Windows/IDataObject.xml b/xml/System.Windows/IDataObject.xml index 86833632dbd..ff8099f3ced 100644 --- a/xml/System.Windows/IDataObject.xml +++ b/xml/System.Windows/IDataObject.xml @@ -85,7 +85,7 @@ . + For an implementation of this method, see . ]]> @@ -132,7 +132,7 @@ . + For an implementation of this method, see . ]]> @@ -184,7 +184,7 @@ . + For an implementation of this method, see . ]]> @@ -202,9 +202,9 @@ . + Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . - Call to obtain a list of all the formats that are available in this data object. + Call to obtain a list of all the formats that are available in this data object. ]]> @@ -251,11 +251,11 @@ . + For an implementation of this method, see . - Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . + Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . - Call to obtain a list of all the formats that are available in this data object. + Call to obtain a list of all the formats that are available in this data object. ]]> @@ -303,11 +303,11 @@ . + For an implementation of this method, . - Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . + Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . - Call to obtain a list of all the formats that are available in this data object. + Call to obtain a list of all the formats that are available in this data object. ]]> @@ -358,11 +358,11 @@ . + For an implementation of this method, see . - Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . + Call **GetDataPresent** to determine whether a specified format is available in this data object before calling . - Call to obtain a list of all the formats that are available in this data object. + Call to obtain a list of all the formats that are available in this data object. This method returns `true` when: @@ -427,7 +427,7 @@ . + For an implementation of this method, see . ]]> @@ -474,7 +474,7 @@ . + For an implementation of this method, see . ]]> @@ -528,7 +528,7 @@ . + For an implementation of this method, see . ]]> @@ -575,7 +575,7 @@ . + For an implementation of this method, see . ]]> @@ -622,7 +622,7 @@ . + For an implementation of this method, see . ]]> @@ -672,7 +672,7 @@ . + For an implementation of this method, see . ]]> diff --git a/xml/System.Windows/IInputElement.xml b/xml/System.Windows/IInputElement.xml index 5e2063d331b..b92a03d635c 100644 --- a/xml/System.Windows/IInputElement.xml +++ b/xml/System.Windows/IInputElement.xml @@ -239,7 +239,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -404,7 +404,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) make this property read/write and establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) make this property read/write and establish this property as a dependency property. ]]> @@ -445,7 +445,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -486,7 +486,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -527,7 +527,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -568,7 +568,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -609,7 +609,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -650,7 +650,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -691,7 +691,7 @@ ## Remarks This interface is not intended for public implementation. For more information, see remarks for the interface. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> @@ -734,7 +734,7 @@ Some core classes that implement , such as , also implement an event that tracks changes to this property. However, this interface does not include such an event as part of its contract. - Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. + Existing implementations in the Windows Presentation Foundation (WPF) core (see and ) establish this property as a dependency property. ]]> diff --git a/xml/System.Windows/IWeakEventListener.xml b/xml/System.Windows/IWeakEventListener.xml index 586c83e60c0..86ce627c783 100644 --- a/xml/System.Windows/IWeakEventListener.xml +++ b/xml/System.Windows/IWeakEventListener.xml @@ -22,17 +22,17 @@ Provides event listening support for classes that expect to receive events through the WeakEvent pattern and a . - (a dispatcher) forwards an event by calling the method on classes that implement this interface, and that have been added as listeners by calling methods beforehand. - - The principal reason for following the WeakEvent pattern is when the event source has an object lifetime that is potentially independent of the event listeners. Using the central event dispatching of a enables the handlers for listeners to be garbage collected (or manually purged) even if the source object lifetime extends beyond the listeners. By contrast, a normal event hookup using `+=` or equivalent language-specific event syntax causes the potentially still-connected source to hold a strong reference to the handlers. This keeps the listener references from being garbage collected in a timely fashion. - - One common situation where the relationships between sources and listeners suggests the use of this pattern is the handling of update events coming from sources for data bindings. - - You can use the WeakEvent pattern to listen for events that are external to your application. You only need to define a for it, provide listening behavior in , and use the to attach the handler references rather than `+=`. - + (a dispatcher) forwards an event by calling the method on classes that implement this interface, and that have been added as listeners by calling methods beforehand. + + The principal reason for following the WeakEvent pattern is when the event source has an object lifetime that is potentially independent of the event listeners. Using the central event dispatching of a enables the handlers for listeners to be garbage collected (or manually purged) even if the source object lifetime extends beyond the listeners. By contrast, a normal event hookup using `+=` or equivalent language-specific event syntax causes the potentially still-connected source to hold a strong reference to the handlers. This keeps the listener references from being garbage collected in a timely fashion. + + One common situation where the relationships between sources and listeners suggests the use of this pattern is the handling of update events coming from sources for data bindings. + + You can use the WeakEvent pattern to listen for events that are external to your application. You only need to define a for it, provide listening behavior in , and use the to attach the handler references rather than `+=`. + ]]> @@ -74,19 +74,19 @@ if the listener handled the event. It is considered an error by the handling in WPF to register a listener for an event that the listener does not handle. Regardless, the method should return if it receives an event that it does not recognize or handle. - to provide WeakEvent pattern support for two hypothetical events `ClockwiseSpin` and `CounterclockwiseSpin` that each have a dedicated (not shown). This implementation calls class handler stubs for each supported event, casting the event data (in this case the two events share an event data type `SpinEventArgs`). The implementation returns `false` if the event received is not one that is expected. - + to provide WeakEvent pattern support for two hypothetical events `ClockwiseSpin` and `CounterclockwiseSpin` that each have a dedicated (not shown). This implementation calls class handler stubs for each supported event, casting the event data (in this case the two events share an event data type `SpinEventArgs`). The implementation returns `false` if the event received is not one that is expected. + :::code language="csharp" source="~/snippets/csharp/System.Windows/ComponentResourceKey/.ctor/corepseudocode.cs" id="Snippetiweakeventlistener"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/ComponentResourceKey/.ctor/corepseudocode.vb" id="Snippetiweakeventlistener"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/ComponentResourceKey/.ctor/corepseudocode.vb" id="Snippetiweakeventlistener"::: + ]]> - This method is intended to receive all possible events where the receiver is in a listener list. Particularly if implementing for a class that is listening for more than one event, you must check the type of the incoming parameter in order to know which event the call corresponds to. This is why each event that is to be part of the pattern must have a dedicated . Also, the parameter is typed as the general . Therefore, in order get any specific properties out of the event data, your implementation will need to cast to the specific event data type. - + This method is intended to receive all possible events where the receiver is in a listener list. Particularly if implementing for a class that is listening for more than one event, you must check the type of the incoming parameter in order to know which event the call corresponds to. This is why each event that is to be part of the pattern must have a dedicated . Also, the parameter is typed as the general . Therefore, in order get any specific properties out of the event data, your implementation will need to cast to the specific event data type. + Typically, after checking for the identity of the event based on the type, your implementation should call a private class handler. Your class handler could conceivably be the very same class handler that is used to handle that event for listeners that are added through the conventional event pattern of adding via to the event on the sender. The following example section provides a rough implementation template. diff --git a/xml/System.Windows/Int32Rect.xml b/xml/System.Windows/Int32Rect.xml index db1f96ff7e6..91e87a8069e 100644 --- a/xml/System.Windows/Int32Rect.xml +++ b/xml/System.Windows/Int32Rect.xml @@ -477,7 +477,7 @@ if and have the same , , , and ; otherwise, . - ]]> + ]]> @@ -515,7 +515,7 @@ if and have the same , , , and ; otherwise, if all of these values are the same, then . - .]]> + .]]> diff --git a/xml/System.Windows/Int32RectConverter.xml b/xml/System.Windows/Int32RectConverter.xml index e01ddf49b2f..a3c70079bab 100644 --- a/xml/System.Windows/Int32RectConverter.xml +++ b/xml/System.Windows/Int32RectConverter.xml @@ -164,11 +164,11 @@ Attempts to convert the specified type to an . The created from converting . - method. - + method. + ]]> The specified object is NULL or is a type that cannot be converted to an . @@ -211,11 +211,11 @@ Attempts to convert an to a specified type. The object created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows/KeySplineConverter.xml b/xml/System.Windows/KeySplineConverter.xml index 46b30a9acd5..5cb429a8eaa 100644 --- a/xml/System.Windows/KeySplineConverter.xml +++ b/xml/System.Windows/KeySplineConverter.xml @@ -165,11 +165,11 @@ Attempts to convert the specified object to a . The created from converting . - method. - + method. + ]]> The specified object is NULL or is a type that cannot be converted to a . @@ -218,11 +218,11 @@ Attempts to convert a to a specified type. The object created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows/LengthConverter.xml b/xml/System.Windows/LengthConverter.xml index 23022c78486..c86dd300288 100644 --- a/xml/System.Windows/LengthConverter.xml +++ b/xml/System.Windows/LengthConverter.xml @@ -24,17 +24,17 @@ Converts instances of other types to and from instances of a that represent an object's length. - supports conversion to and from the following types: , , , , , , , , , and . - -## Examples - The following example shows how to create and use an instance of the object. A custom method called `ChangeLeft` is defined, which converts the content of a (defined in a separate Extensible Application Markup Language (XAML) file) to an instance of , and later into a . This method passes the to a object, which converts the to an instance of . Notice that this value has already been converted to a by using the method. This value is then passed back to the method and the method of the in order to change the position of the `text1` object. - + supports conversion to and from the following types: , , , , , , , , , and . + +## Examples + The following example shows how to create and use an instance of the object. A custom method called `ChangeLeft` is defined, which converts the content of a (defined in a separate Extensible Application Markup Language (XAML) file) to an instance of , and later into a . This method passes the to a object, which converts the to an instance of . Notice that this value has already been converted to a by using the method. This value is then passed back to the method and the method of the in order to change the position of the `text1` object. + :::code language="csharp" source="~/snippets/csharp/System.Windows/LengthConverter/Overview/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/LengthConverter/Overview/Window1.xaml.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/LengthConverter/Overview/Window1.xaml.vb" id="Snippet2"::: + ]]> @@ -104,11 +104,11 @@ if conversion is possible; otherwise, . - supports conversion to and from the following types: , , , , , , , , , and . - + supports conversion to and from the following types: , , , , , , , , , and . + ]]> @@ -147,11 +147,11 @@ if conversion to the is possible; otherwise, . - supports conversion of the following types: , , , , , , , , , and . - + supports conversion of the following types: , , , , , , , , , and . + ]]> @@ -191,11 +191,11 @@ Converts instances of other data types into instances of that represent an object's length. An instance of that is the value of the conversion. - supports conversion of the following types: , , , , , , , , , . - + supports conversion of the following types: , , , , , , , , , . + ]]> Occurs if the is . diff --git a/xml/System.Windows/LineStackingStrategy.xml b/xml/System.Windows/LineStackingStrategy.xml index ac804a7efc7..8f7d7df9ab5 100644 --- a/xml/System.Windows/LineStackingStrategy.xml +++ b/xml/System.Windows/LineStackingStrategy.xml @@ -26,7 +26,7 @@ property to determine how the line boxes are created for text lines of a . The first has a value of MaxHeight and the second has a value of BlockLineHeight. + The following example shows how to use the property to determine how the line boxes are created for text lines of a . The first has a value of MaxHeight and the second has a value of BlockLineHeight. :::code language="xaml" source="~/snippets/csharp/System.Windows/BaselineAlignment/Overview/linestackingstrategyexample.xaml" id="Snippetlinestackingstrategyexamplewholepage"::: diff --git a/xml/System.Windows/LocalValueEntry.xml b/xml/System.Windows/LocalValueEntry.xml index a0726017df9..ac6c20907f3 100644 --- a/xml/System.Windows/LocalValueEntry.xml +++ b/xml/System.Windows/LocalValueEntry.xml @@ -29,7 +29,7 @@ ## Remarks Instances of this class are returned when getting the value of the property of a . All properties are read-only. - This class has no public constructor. In order to obtain instances of this class you must call , and then get the value of from the returned . + This class has no public constructor. In order to obtain instances of this class you must call , and then get the value of from the returned . @@ -144,7 +144,7 @@ implementation compares the values of the , and potentially compares the values of . The component of a is always a value type, so this comparison will always be a bitwise value comparison. For the component, this implementation employs a bitwise comparison if it is a value type. + This implementation compares the values of the , and potentially compares the values of . The component of a is always a value type, so this comparison will always be a bitwise value comparison. For the component, this implementation employs a bitwise comparison if it is a value type. For locally set properties that have reference types, the behavior is deferred to that type's equality determination mechanisms, because it uses the `==` operator on the two values internally. By default, this is a reference equality of the values. @@ -270,7 +270,7 @@ for the current and get its . + To determine a more specific type for this value, check the for the current and get its . ]]> diff --git a/xml/System.Windows/LocalValueEnumerator.xml b/xml/System.Windows/LocalValueEnumerator.xml index dcb7d98852a..ffb5446b1ae 100644 --- a/xml/System.Windows/LocalValueEnumerator.xml +++ b/xml/System.Windows/LocalValueEnumerator.xml @@ -28,17 +28,17 @@ Provides enumeration support for the local values of any dependency properties that exist on a . - , or more typically by using the set accessor of a CLR property wrapper that calls internally. Examples of other property system determinants that are not local values are values set through styles, or dependency property default values. For details, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). - - A is returned by the method and implements the interface. A public constructor does not exist; therefore, you must call to obtain an instance of this class. - - Do not modify local values (by calling or ) while enumerating local values. If you change or clear the property values based on properties that are returned by the enumerator, the change or clear operations do not invalidate the enumerator collection, as is the case for many implementations. Also, the enumerator view is a snapshot. A change to the collection is not guaranteed to be thread safe, and no lock is enforced. Other threads still have free access to the local values from a context other than the enumerator. - - Use this type if you have operations in your class where it is important to know whether a property's value came from a local value. For example, use this type in an implementation, or where you want to query the metadata on all locally set properties. - + , or more typically by using the set accessor of a CLR property wrapper that calls internally. Examples of other property system determinants that are not local values are values set through styles, or dependency property default values. For details, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence). + + A is returned by the method and implements the interface. A public constructor does not exist; therefore, you must call to obtain an instance of this class. + + Do not modify local values (by calling or ) while enumerating local values. If you change or clear the property values based on properties that are returned by the enumerator, the change or clear operations do not invalidate the enumerator collection, as is the case for many implementations. Also, the enumerator view is a snapshot. A change to the collection is not guaranteed to be thread safe, and no lock is enforced. Other threads still have free access to the local values from a context other than the enumerator. + + Use this type if you have operations in your class where it is important to know whether a property's value came from a local value. For example, use this type in an implementation, or where you want to query the metadata on all locally set properties. + ]]> @@ -77,11 +77,11 @@ Gets the number of items that are represented in the collection. The number of items in the collection. - but is provided as a convenience. - + but is provided as a convenience. + ]]> @@ -113,11 +113,11 @@ Gets the current element in the collection. The current in the collection. - How to: Restore the Default Value of a Dependency Property @@ -155,11 +155,11 @@ if the specified is equal to the current ; otherwise, . - @@ -262,11 +262,11 @@ if the is equal to the ; otherwise, . - @@ -305,11 +305,11 @@ if the instances are not equal; otherwise, . - @@ -376,11 +376,11 @@ For a description of this members, see . The current element in the collection. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Windows/Localization.xml b/xml/System.Windows/Localization.xml index 08704f678ee..8bfe6719270 100644 --- a/xml/System.Windows/Localization.xml +++ b/xml/System.Windows/Localization.xml @@ -101,7 +101,7 @@ attached property for a button. + The following code example shows how to get and set the attached property for a button. @@ -164,7 +164,7 @@ attached property for a text block. + The following code example shows how to get and set the attached property for a text block. diff --git a/xml/System.Windows/LogicalTreeHelper.xml b/xml/System.Windows/LogicalTreeHelper.xml index d16dddcaa08..3d7fc521174 100644 --- a/xml/System.Windows/LogicalTreeHelper.xml +++ b/xml/System.Windows/LogicalTreeHelper.xml @@ -29,9 +29,9 @@ ## Remarks The class provides methods that you can use to return child collections of objects, or specific objects from within subnodes of the logical tree. However, most of the object tree operations that you typically perform are also exposed by similar methods or properties on or . For example, try the following: -- Instead of calling the static method, which returns an enumerator for the logical child objects, use the dedicated collection exposed in the content model for that object. Nearly all objects that support a content model expose some property that contains the collection of child objects, and provides collection interface support directly on that collection. +- Instead of calling the static method, which returns an enumerator for the logical child objects, use the dedicated collection exposed in the content model for that object. Nearly all objects that support a content model expose some property that contains the collection of child objects, and provides collection interface support directly on that collection. -- Instead of calling the static method to obtain a child object by specifying its name, call the or method on specific objects. +- Instead of calling the static method to obtain a child object by specifying its name, call the or method on specific objects. is most useful for analysis scenarios where you are traveling up or down the logical tree recursively through multiple levels, and want to use a consistent approach for examining the various parent or child objects. In this case, you might be accessing a mixture of content models, and using the more content-model specific APIs would be too complex. @@ -72,7 +72,7 @@ or rather than this static utility method. The behavior of the instance methods is equivalent to the behavior of the static method. + It is typically more convenient to call the instance methods or rather than this static utility method. The behavior of the instance methods is equivalent to the behavior of the static method. Even if the `current` UI element provided was a , the resulting event is still the same event, with the originating identifiable by checking the event data of the event. @@ -117,11 +117,11 @@ and are superficially similar to , but operate by different logic: + The methods and are superficially similar to , but operate by different logic: -- The search direction for is toward child objects (down the tree); the search direction for the `FindName` methods is towards parent objects (up the tree). +- The search direction for is toward child objects (down the tree); the search direction for the `FindName` methods is towards parent objects (up the tree). -- The `FindName` methods are governed by the concept of a XAML namescope. Using `FindName` you are guaranteed that only one object of that name exists, because XAML namescopes enforce uniqueness. In contrast, ignores XAML namescope and might cross XAML namescope boundaries during the search. As such, there is no guarantee of uniqueness of the `elementName` name once boundaries are crossed. For more information about XAML namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). +- The `FindName` methods are governed by the concept of a XAML namescope. Using `FindName` you are guaranteed that only one object of that name exists, because XAML namescopes enforce uniqueness. In contrast, ignores XAML namescope and might cross XAML namescope boundaries during the search. As such, there is no guarantee of uniqueness of the `elementName` name once boundaries are crossed. For more information about XAML namescopes, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). ]]> @@ -276,7 +276,7 @@ or ) of the or property; so unless you are unable to determine the `current` type, you might want to check the respective instance properties instead. + This method is merely a wrapper that gets the appropriate type version ( or ) of the or property; so unless you are unable to determine the `current` type, you might want to check the respective instance properties instead. ]]> diff --git a/xml/System.Windows/MessageBox.xml b/xml/System.Windows/MessageBox.xml index a2d897097d9..ad4b0e5c9ab 100644 --- a/xml/System.Windows/MessageBox.xml +++ b/xml/System.Windows/MessageBox.xml @@ -24,25 +24,25 @@ Displays a message box. - method of the class. The text message that is displayed is the string argument that you pass to . Several overloads of the method also enables you to provide a title bar caption. - - To enable a user to close a message box, displays a message box that has an **OK** button and a **Close** button in the title bar. - - You can also use a message box to ask a user a question. The user answers by clicking one of several buttons that you specify to display by using the enumeration. You can pass this enumeration to several overloads of the method. The default value of the enumeration is . - - You can determine which button a user clicks by examining the value that returns. The return value is a value of the enumeration, where each value equates to one of the buttons that a message box can display. The default value for message box is because **OK** is the default message box button. However, some overloads of the method enable you to provide a different default value. - - Message boxes can communicate information and can ask questions that have varying degrees of importance. Message boxes use icons to indicate importance. For example, icons can indicate whether the message is informational, is a warning, or is important. The enumeration encapsulates the set of possible message box icons. By default, a message box does not display an icon. However, you can pass a value to one of several method overloads in order to specify that the message box includes an icon. - - Message boxes sometimes provide special functionality, such as right-to-left reading. You can customize the behavior of a message box by using one or more enumeration values that are accepted by some overloads of the method. - - Message boxes always have an owner window. By default, the owner of a message box is the window that is currently active in an application at the time that a message box is opened. However, you can specify another owner for the by using one of several overloads. For more information about owner windows, see . - - For more information, see [MessageBox Sample](https://go.microsoft.com/fwlink/?LinkID=160023). - + method of the class. The text message that is displayed is the string argument that you pass to . Several overloads of the method also enables you to provide a title bar caption. + + To enable a user to close a message box, displays a message box that has an **OK** button and a **Close** button in the title bar. + + You can also use a message box to ask a user a question. The user answers by clicking one of several buttons that you specify to display by using the enumeration. You can pass this enumeration to several overloads of the method. The default value of the enumeration is . + + You can determine which button a user clicks by examining the value that returns. The return value is a value of the enumeration, where each value equates to one of the buttons that a message box can display. The default value for message box is because **OK** is the default message box button. However, some overloads of the method enable you to provide a different default value. + + Message boxes can communicate information and can ask questions that have varying degrees of importance. Message boxes use icons to indicate importance. For example, icons can indicate whether the message is informational, is a warning, or is important. The enumeration encapsulates the set of possible message box icons. By default, a message box does not display an icon. However, you can pass a value to one of several method overloads in order to specify that the message box includes an icon. + + Message boxes sometimes provide special functionality, such as right-to-left reading. You can customize the behavior of a message box by using one or more enumeration values that are accepted by some overloads of the method. + + Message boxes always have an owner window. By default, the owner of a message box is the window that is currently active in an application at the time that a message box is opened. However, you can specify another owner for the by using one of several overloads. For more information about owner windows, see . + + For more information, see [MessageBox Sample](https://go.microsoft.com/fwlink/?LinkID=160023). + ]]> @@ -59,11 +59,11 @@ Displays a message box. - method, which enables you to specify an owner window. Otherwise, the message box is owned by the window that is currently active. - + method, which enables you to specify an owner window. Otherwise, the message box is owned by the window that is currently active. + ]]> @@ -105,14 +105,14 @@ Displays a message box that has a message and that returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show1Window.xaml.cs" id="Snippetmessageboxshow1code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show1window.xaml.vb" id="Snippetmessageboxshow1code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show1window.xaml.vb" id="Snippetmessageboxshow1code"::: + ]]> @@ -156,14 +156,14 @@ Displays a message box that has a message and title bar caption; and that returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show2Window.xaml.cs" id="Snippetmessageboxshow2code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show2window.xaml.vb" id="Snippetmessageboxshow2code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show2window.xaml.vb" id="Snippetmessageboxshow2code"::: + ]]> @@ -207,11 +207,11 @@ Displays a message box in front of the specified window. The message box displays a message and returns a result. A value that specifies which message box button is clicked by the user. - @@ -259,14 +259,14 @@ Displays a message box that has a message, title bar caption, and button; and that returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show3Window.xaml.cs" id="Snippetmessageboxshow3code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show3window.xaml.vb" id="Snippetmessageboxshow3code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show3window.xaml.vb" id="Snippetmessageboxshow3code"::: + ]]> @@ -312,11 +312,11 @@ Displays a message box in front of the specified window. The message box displays a message and title bar caption; and it returns a result. A value that specifies which message box button is clicked by the user. - @@ -366,14 +366,14 @@ Displays a message box that has a message, title bar caption, button, and icon; and that returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show4Window.xaml.cs" id="Snippetmessageboxshow4code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show4window.xaml.vb" id="Snippetmessageboxshow4code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show4window.xaml.vb" id="Snippetmessageboxshow4code"::: + ]]> @@ -421,11 +421,11 @@ Displays a message box in front of the specified window. The message box displays a message, title bar caption, and button; and it also returns a result. A value that specifies which message box button is clicked by the user. - @@ -477,14 +477,14 @@ Displays a message box that has a message, title bar caption, button, and icon; and that accepts a default message box result and returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show5Window.xaml.cs" id="Snippetmessageboxshow5code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show5window.xaml.vb" id="Snippetmessageboxshow5code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show5window.xaml.vb" id="Snippetmessageboxshow5code"::: + ]]> @@ -534,11 +534,11 @@ Displays a message box in front of the specified window. The message box displays a message, title bar caption, button, and icon; and it also returns a result. A value that specifies which message box button is clicked by the user. - @@ -592,14 +592,14 @@ Displays a message box that has a message, title bar caption, button, and icon; and that accepts a default message box result, complies with the specified options, and returns a result. A value that specifies which message box button is clicked by the user. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/System.Windows/MessageBox/Show/Show6Window.xaml.cs" id="Snippetmessageboxshow6code"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show6window.xaml.vb" id="Snippetmessageboxshow6code"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/MessageBox/Show/show6window.xaml.vb" id="Snippetmessageboxshow6code"::: + ]]> @@ -651,11 +651,11 @@ Displays a message box in front of the specified window. The message box displays a message, title bar caption, button, and icon; and accepts a default message box result and returns a result. A value that specifies which message box button is clicked by the user. - @@ -711,11 +711,11 @@ Displays a message box in front of the specified window. The message box displays a message, title bar caption, button, and icon; and accepts a default message box result, complies with the specified options, and returns a result. A value that specifies which message box button is clicked by the user. - diff --git a/xml/System.Windows/MessageBoxButton.xml b/xml/System.Windows/MessageBoxButton.xml index 42f1de81507..2df1b6ce619 100644 --- a/xml/System.Windows/MessageBoxButton.xml +++ b/xml/System.Windows/MessageBoxButton.xml @@ -23,20 +23,20 @@ Specifies the buttons that are displayed on a message box. Used as an argument of the method. - method displays a message box that has an **OK** button. You can use overloads of the method that accept a `MessageBoxButton` argument in order to specify different combinations of buttons, which include **OK**, **OK**/**Cancel**, **Yes**/**No**, and **Yes**/**No**/**Cancel**. - -The value of the button that a user clicks is returned by and is one of the values of the enumeration. + method displays a message box that has an **OK** button. You can use overloads of the method that accept a `MessageBoxButton` argument in order to specify different combinations of buttons, which include **OK**, **OK**/**Cancel**, **Yes**/**No**, and **Yes**/**No**/**Cancel**. + +The value of the button that a user clicks is returned by and is one of the values of the enumeration. + + If you specify `YesNo`, you disable the **Close** button in the message box title bar. However, the **Close** button is enabled for all other options. When a user clicks the **Close** button or presses the **ESC** key, a message box returns a message box result value of . However, if a message box displays only an **OK** button, clicking the **Close** button or pressing the **ESC** key causes a message box to return a message box result value of . + + + +## Examples + For more information, see the [MessageBox Sample](https://go.microsoft.com/fwlink/?LinkID=160023) on GitHub. - If you specify `YesNo`, you disable the **Close** button in the message box title bar. However, the **Close** button is enabled for all other options. When a user clicks the **Close** button or presses the **ESC** key, a message box returns a message box result value of . However, if a message box displays only an **OK** button, clicking the **Close** button or pressing the **ESC** key causes a message box to return a message box result value of . - - - -## Examples - For more information, see the [MessageBox Sample](https://go.microsoft.com/fwlink/?LinkID=160023) on GitHub. - ]]> diff --git a/xml/System.Windows/MessageBoxResult.xml b/xml/System.Windows/MessageBoxResult.xml index 2605354a6d6..7773eb0b5a5 100644 --- a/xml/System.Windows/MessageBoxResult.xml +++ b/xml/System.Windows/MessageBoxResult.xml @@ -26,7 +26,7 @@ returns a value that specifies which button on a message box a user clicked. specifies which buttons are displayed on a message box. + returns a value that specifies which button on a message box a user clicked. specifies which buttons are displayed on a message box. The result value that is returned from a message box depends on what buttons the message box has and how a user closes a message box: diff --git a/xml/System.Windows/MultiDataTrigger.xml b/xml/System.Windows/MultiDataTrigger.xml index 531d6d2f41b..ae64a9b8a6a 100644 --- a/xml/System.Windows/MultiDataTrigger.xml +++ b/xml/System.Windows/MultiDataTrigger.xml @@ -37,16 +37,16 @@ object is similar to a , except that the conditions of a are based on property values of bound data instead of those of a . In a , a condition is met when the property value of the data item matches the specified . You can then use setters or the and properties to apply changes or start actions when all of the conditions are met. + A object is similar to a , except that the conditions of a are based on property values of bound data instead of those of a . In a , a condition is met when the property value of the data item matches the specified . You can then use setters or the and properties to apply changes or start actions when all of the conditions are met. - The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. For information about when to use triggers and when to use other techniques, see [Data Templating Overview](/dotnet/framework/wpf/data/data-templating-overview). ## Examples - In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. + In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. Each of the displays a `Place` object. The in the example is applied to each . The elements of the specify that if the `Name` and `State` of the `Place` data item are `Portland` and `OR` respectively, then the background of corresponding is set to `Cyan`. @@ -118,9 +118,9 @@ object is similar to a , except that the conditions of a are based on property values of bound data instead of those of a . In a , a condition is met when the property value of the data item matches the specified . That value is first converted to the type of the value of the binding, if possible, and then the two values are compared using the `Object.Equals` method. The applies the associated setters or actions when all of the conditions are true (binary `AND` operation). + A object is similar to a , except that the conditions of a are based on property values of bound data instead of those of a . In a , a condition is met when the property value of the data item matches the specified . That value is first converted to the type of the value of the binding, if possible, and then the two values are compared using the `Object.Equals` method. The applies the associated setters or actions when all of the conditions are true (binary `AND` operation). - For a , each condition in the collection must set both the and properties. For more information, see . + For a , each condition in the collection must set both the and properties. For more information, see . ## XAML Property Element Usage @@ -141,7 +141,7 @@ ## Examples - In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. + In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. Each of the displays a `Place` object. The in the example is applied to each . The elements of the specify that if the `Name` and `State` of the `Place` data item are `Portland` and `OR` respectively, then the background of corresponding is set to `Cyan`. @@ -188,11 +188,11 @@ enables you to start actions by using the or properties, or to set property values by using objects when the bound data meet a set of conditions. + enables you to start actions by using the or properties, or to set property values by using objects when the bound data meet a set of conditions. If there are two objects in the same or different setter collections setting the same property, the that is declared last is used. - Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. ## XAML Property Element Usage @@ -211,7 +211,7 @@ ## Examples - In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. + In the following example, the property of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. The definition of `Place` and `Places` are not shown. Each of the displays a `Place` object. The in the example is applied to each . The elements of the specify that if the `Name` and `State` of the `Place` data item are `Portland` and `OR` respectively, then the background of corresponding is set to `Cyan`. diff --git a/xml/System.Windows/MultiTrigger.xml b/xml/System.Windows/MultiTrigger.xml index 0dd6ac96ca6..f5f1b9b0c7b 100644 --- a/xml/System.Windows/MultiTrigger.xml +++ b/xml/System.Windows/MultiTrigger.xml @@ -37,9 +37,9 @@ enables you to set property values or start actions based on a collection of s. A condition is met when the value of the property (specified by the property of the class) of the element matches the specified . The comparison is a reference equality check. You can then use setters or the and properties to apply changes or start actions when all of the conditions are met. + enables you to set property values or start actions based on a collection of s. A condition is met when the value of the property (specified by the property of the class) of the element matches the specified . The comparison is a reference equality check. You can then use setters or the and properties to apply changes or start actions when all of the conditions are met. - The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + The property of a object can only consist of objects. Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. @@ -132,9 +132,9 @@ *ZeroOrMoreConditions* Zero or more objects. - enables you to set property values or start actions based on a collection of objects. A condition is met when the value of the property (specified by the property of the class) of the element matches the specified . The comparison that is performed is a reference equality check. The applies the associated setters or actions when all of the conditions are true (binary and operation). + enables you to set property values or start actions based on a collection of objects. A condition is met when the value of the property (specified by the property of the class) of the element matches the specified . The comparison that is performed is a reference equality check. The applies the associated setters or actions when all of the conditions are true (binary and operation). - Note that for s, each condition in the collection must set both the and properties. See the page for more information. + Note that for s, each condition in the collection must set both the and properties. See the page for more information. @@ -205,7 +205,7 @@ If there are two objects in the same or different setter collections setting the same property, the Setter that is declared last is used. - Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. + Adding a child to a object implicitly adds it to the for the object. objects are not supported; only supports objects. diff --git a/xml/System.Windows/NameScope.xml b/xml/System.Windows/NameScope.xml index 69f0a01920e..4909d390308 100644 --- a/xml/System.Windows/NameScope.xml +++ b/xml/System.Windows/NameScope.xml @@ -82,11 +82,11 @@ ## Remarks This class implements built-in XAML namescope support for WPF treatment of XAML. assists in creation of initial XAML namescopes based on parsing XAML, such as when instantiating styles and templates. It also supports creation of XAML namescopes by processes that occur outside of normal XAML loading of elements by the WPF XAML processor implementation. - is generally more devoted to supplying infrastructure than for common user code scenarios that involve working with a XAML namescope. For most scenarios, the methods exposed on and are more appropriate methods to call to search for elements by XAML-defined name. The properties exposed by and are more appropriate properties to use to set the initial name as markup attributes. + is generally more devoted to supplying infrastructure than for common user code scenarios that involve working with a XAML namescope. For most scenarios, the methods exposed on and are more appropriate methods to call to search for elements by XAML-defined name. The properties exposed by and are more appropriate properties to use to set the initial name as markup attributes. - The various methods of are used by base elements and other classes that maintain XAML namescopes in order to support and . You generally use the API in the class only if you are replacing or augmenting the base element behavior for how they process XAML namescopes for root elements of a XAML page, and as part of templates (which use a separate XAML namescope from the rest of the page). + The various methods of are used by base elements and other classes that maintain XAML namescopes in order to support and . You generally use the API in the class only if you are replacing or augmenting the base element behavior for how they process XAML namescopes for root elements of a XAML page, and as part of templates (which use a separate XAML namescope from the rest of the page). - In .NET Framework 4, provides collection interface implementations such that you can access the collections of names that are held by a XAML namescope, including adding to it through calls to an method. + In .NET Framework 4, provides collection interface implementations such that you can access the collections of names that are held by a XAML namescope, including adding to it through calls to an method. For more information on XAML namescope concepts, see [WPF XAML Namescopes](/dotnet/framework/wpf/advanced/wpf-xaml-namescopes). @@ -218,7 +218,7 @@ so that it is not necessary to involve the type in your usage. + This method basically wraps so that it is not necessary to involve the type in your usage. Names in a XAML namescope must use a particular grammar that restricts the strings you might use for inputs of API. See [XamlName Grammar](/dotnet/framework/xaml-services/xamlname-grammar). @@ -302,7 +302,7 @@ instead. + Generally you are only interested in whether a name is already defined in the XAML namescope, and what object reference value it is mapped to is immaterial. For this scenario, you can call instead. ]]> @@ -522,7 +522,7 @@ as an attached property in XAML usage, and to provide the accessor for performing the equivalent operation in code. + The purpose of this method is both to implement the `get` accessor for using as an attached property in XAML usage, and to provide the accessor for performing the equivalent operation in code. ]]> @@ -671,7 +671,7 @@ and accessors in code. Setting the namescope in XAML is not common. The attached property usage is primarily to facilitate attaching XAML namescopes to objects that do not share inheritance for XAML namescope implementations. and derived classes support this inheritance natively. + This attached property requires attached property usage in XAML, or use of the and accessors in code. Setting the namescope in XAML is not common. The attached property usage is primarily to facilitate attaching XAML namescopes to objects that do not share inheritance for XAML namescope implementations. and derived classes support this inheritance natively. ## Dependency Property Information @@ -821,7 +821,7 @@ is a dictionary there is no concept of first occurrence; any given is guaranteed unique. + Because is a dictionary there is no concept of first occurrence; any given is guaranteed unique. ]]> @@ -867,7 +867,7 @@ , returning `false` in cases that otherwise would have raised exceptions in . + This method basically wraps , returning `false` in cases that otherwise would have raised exceptions in . ]]> @@ -911,7 +911,7 @@ as an attached property in XAML usage, and to provide the accessor for performing the equivalent operation in code. + The purpose of this method is both to act as the `set` accessor for using as an attached property in XAML usage, and to provide the accessor for performing the equivalent operation in code. ]]> @@ -1087,7 +1087,7 @@ This member is an explicit interface member implementation. It can be used only to determine whether a specific name-object mapping exists. + Before calling this method, you can use to determine whether a specific name-object mapping exists. ]]> diff --git a/xml/System.Windows/Point.xml b/xml/System.Windows/Point.xml index aa8149e0781..bed695a4f33 100644 --- a/xml/System.Windows/Point.xml +++ b/xml/System.Windows/Point.xml @@ -46,9 +46,9 @@ and values of a can be either a comma or a space. + In XAML, the delimiter between the and values of a can be either a comma or a space. - Some cultures might use the comma character as the decimal delimiter instead of the period character. XAML processing for invariant culture defaults to en-US in most XAML processor implementations, and expects the period to be the decimal delimiter. You should avoid using the comma character as the decimal delimiter if specifying a in XAML, because that will clash with the string type conversion of a attribute value into the and components. + Some cultures might use the comma character as the decimal delimiter instead of the period character. XAML processing for invariant culture defaults to en-US in most XAML processor implementations, and expects the period to be the decimal delimiter. You should avoid using the comma character as the decimal delimiter if specifying a in XAML, because that will clash with the string type conversion of a attribute value into the and components. ## XAML Attribute Usage @@ -215,7 +215,7 @@ ## Examples - The following example shows how to check if two structures are equal using the non-static method. + The following example shows how to check if two structures are equal using the non-static method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetnonstaticequalsexample_csharp"::: @@ -308,7 +308,7 @@ ## Examples - The following example shows how to check if two structures are equal using the static method. + The following example shows how to check if two structures are equal using the static method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetstaticequalsexample_csharp"::: @@ -392,7 +392,7 @@ structure by a structure using the method. + The following example shows how to multiply a structure by a structure using the method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetmultiplypointbymatrixexample_csharp"::: @@ -438,12 +438,12 @@ ## Remarks This operation is equivalent to adding a to a . - Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. ## Examples - The following example shows how to offset the and values of a structure. + The following example shows how to offset the and values of a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetoffsetexample_csharp"::: @@ -592,7 +592,7 @@ structure cannot be negative, the absolute values of the point's and properties are used. + Because a structure cannot be negative, the absolute values of the point's and properties are used. @@ -686,7 +686,7 @@ and coordinates are described using values. Because values can lose precision when operated on, a comparison between two values that are logically equal might fail. + A point's and coordinates are described using values. Because values can lose precision when operated on, a comparison between two values that are logically equal might fail. @@ -881,7 +881,7 @@ method to convert a representation of a point into a structure. + The following example shows how to use the method to convert a representation of a point into a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetparseexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Point/Overview/pointexample.vb" id="Snippetparseexample"::: @@ -943,7 +943,7 @@ from another using the static method. + The following example shows how to subtract a from another using the static method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetsubtractexample2"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Point/Overview/pointexample.vb" id="Snippetsubtractexample2"::: @@ -989,7 +989,7 @@ from a using the static method. + The following example shows how to subtract a from a using the static method. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetsubtractexample1"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Point/Overview/pointexample.vb" id="Snippetsubtractexample1"::: @@ -1097,7 +1097,7 @@ method to get a representation of a structure. + The following example shows how to use the method to get a representation of a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippettostringexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Point/Overview/pointexample.vb" id="Snippettostringexample"::: diff --git a/xml/System.Windows/PointConverter.xml b/xml/System.Windows/PointConverter.xml index d61a3705490..dd51f69fe1a 100644 --- a/xml/System.Windows/PointConverter.xml +++ b/xml/System.Windows/PointConverter.xml @@ -24,13 +24,13 @@ Converts instances of other types to and from a . - to convert a string into a . - - :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetpointconverterexample_csharp"::: - + to convert a string into a . + + :::code language="csharp" source="~/snippets/csharp/System.Windows/Point/Overview/PointExample.cs" id="Snippetpointconverterexample_csharp"::: + ]]> @@ -174,11 +174,11 @@ Attempts to convert the specified object to a . The created from converting . - method. - + method. + ]]> The specified object is NULL or is a type that cannot be converted to a . @@ -221,11 +221,11 @@ Attempts to convert a to a specified type. The object created from converting this . - method. - + method. + ]]> diff --git a/xml/System.Windows/PresentationSource.xml b/xml/System.Windows/PresentationSource.xml index a499459b752..2c39306a9df 100644 --- a/xml/System.Windows/PresentationSource.xml +++ b/xml/System.Windows/PresentationSource.xml @@ -140,11 +140,11 @@ Even though this is a routed event, there are special restrictions placed on this event that differ from normal routed event behavior, due to the relatively small number of elements in a typical application scenario that would concern themselves with handling this event. -- You cannot use the or methods to add handlers. You must use . +- You cannot use the or methods to add handlers. You must use . - The C# `+=` and `-=` event handler syntaxes, and related language-specific handler syntaxes, are not supported, because the event itself is not exposed as public. Only the utility methods for adding and removing the handlers directly are supported. -- Class handlers are not allowed. Specifically, you cannot call against this event in a class constructor because although an identifier field exists for SourceChanged, the identifier is not public. +- Class handlers are not allowed. Specifically, you cannot call against this event in a class constructor because although an identifier field exists for SourceChanged, the identifier is not public. - All registered handlers will receive the SourceChanged event even if one of the handlers attempts to mark the arguments as handled. @@ -222,7 +222,7 @@ . + The return of this property relies on an implementation of . ]]> @@ -296,7 +296,7 @@ . + The returned list supports an enumerator over a read-only, thread-safe copy of the list of sources as added with . The enumerator skips any dead weak references in the list. @@ -518,7 +518,7 @@ ## Remarks Even though this is a routed event, there are special restrictions placed on this event that differ from normal routed event behavior, due to the relatively small number of elements in a typical application scenario that would concern themselves with handling this event. -- You cannot use the or methods to remove handlers. You must use . +- You cannot use the or methods to remove handlers. You must use . - The C# `+=` and `-=` event handler syntaxes, and other language-specific handler syntaxes, are not supported, because the event itself is not exposed as public. Only the utility methods for adding and removing the handlers directly are supported. diff --git a/xml/System.Windows/PropertyMetadata.xml b/xml/System.Windows/PropertyMetadata.xml index 93936e63f91..e28a16af6ad 100644 --- a/xml/System.Windows/PropertyMetadata.xml +++ b/xml/System.Windows/PropertyMetadata.xml @@ -24,19 +24,19 @@ Defines certain behavior aspects of a dependency property as it is applied to a specific type, including conditions it was registered with. - method (or variations for attached properties or read-only dependency properties), or after original owner registration when calling the method. also takes property metadata. - - This class is a concrete base class that can be used in each of these calls. However, it is very common to specify metadata using one of the derived classes such as . These derived classes support more detailed metadata carried as Boolean property values, which are useful for either detecting or enabling some property system and layout behaviors that are only implemented at the WPF framework level. - - Several properties of this class are read-write to the object model, but can only be written prior to the instance being used in a property system operation such as or . Each of these properties could also have been set by the constructor but are exposed so that method implementations can set them. - - -## XAML Text Usage - This type, and members of this type, are not typically used in XAML. - + method (or variations for attached properties or read-only dependency properties), or after original owner registration when calling the method. also takes property metadata. + + This class is a concrete base class that can be used in each of these calls. However, it is very common to specify metadata using one of the derived classes such as . These derived classes support more detailed metadata carried as Boolean property values, which are useful for either detecting or enabling some property system and layout behaviors that are only implemented at the WPF framework level. + + Several properties of this class are read-write to the object model, but can only be written prior to the instance being used in a property system operation such as or . Each of these properties could also have been set by the constructor but are exposed so that method implementations can set them. + + +## XAML Text Usage + This type, and members of this type, are not typically used in XAML. + ]]> @@ -108,19 +108,19 @@ The default value to specify for a dependency property, usually provided as a value of some specific type. Initializes a new instance of the class with a specified default value for the dependency property that this metadata will be applied to. - cannot be specified. Attempting to do so will raise an exception. - - - -## Examples - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: -:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor1param"::: - + cannot be specified. Attempting to do so will raise an exception. + + + +## Examples + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: +:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor1param"::: + ]]> @@ -154,12 +154,12 @@ Reference to a handler implementation that is to be called by the property system whenever the effective value of the property changes. Initializes a new instance of the class with the specified implementation reference. - @@ -193,19 +193,19 @@ Reference to a handler implementation that is to be called by the property system whenever the effective value of the property changes. Initializes a new instance of the class with the specified default value and implementation reference. - cannot be specified. Attempting to do so will raise an exception. - - - -## Examples - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: -:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor2param"::: - + cannot be specified. Attempting to do so will raise an exception. + + + +## Examples + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: +:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor2param"::: + ]]> @@ -243,21 +243,21 @@ Reference to a handler implementation that is to be called whenever the property system calls against this property. Initializes a new instance of the class with the specified default value and callbacks. - but not a , you can pass `null` for the `propertyChangedCallback` parameter. - - The type of the value provided for `defaultValue` must be match or be related to the type specified in the original registration of the dependency property that this metadata will be applied to. Mismatches between metadata default value type and the type of the dependency property it is being applied to can be difficult to debug, because the mismatch is not detectable during compilation (the mismatch will raise a run-time exception). - - Although it is the default per the parameterless constructor, a `defaultValue` of cannot be specified. Attempting to do so will raise an exception. - - - -## Examples - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: -:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor3param"::: - + but not a , you can pass `null` for the `propertyChangedCallback` parameter. + + The type of the value provided for `defaultValue` must be match or be related to the type specified in the original registration of the dependency property that this metadata will be applied to. Mismatches between metadata default value type and the type of the dependency property it is being applied to can be difficult to debug, because the mismatch is not detectable during compilation (the mismatch will raise a run-time exception). + + Although it is the default per the parameterless constructor, a `defaultValue` of cannot be specified. Attempting to do so will raise an exception. + + + +## Examples + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetinitpm"::: +:::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetpmctor3param"::: + ]]> @@ -297,13 +297,13 @@ Gets or sets a reference to a implementation specified in this metadata. A implementation reference. - . However, the default merge logic for a is to replace the previous one. - - is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. - + . However, the default merge logic for a is to replace the previous one. + + is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. + ]]> Cannot set a metadata property once it is applied to a dependency property operation. @@ -336,17 +336,17 @@ Gets or sets the default value of the dependency property. The default value of the property. The default value on a instance created with the parameterless constructor will be . - is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. - - Although it is the default per the parameterless constructor, a `defaultValue` of cannot be set using either or the constructor. Attempting to do so will raise an exception. - - -## XAML Text Usage - Members of this type are not typically used in XAML. - + is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. + + Although it is the default per the parameterless constructor, a `defaultValue` of cannot be set using either or the constructor. Attempting to do so will raise an exception. + + +## XAML Text Usage + Members of this type are not typically used in XAML. + ]]> Cannot be set to the value once created. @@ -387,18 +387,18 @@ if the metadata instance is immutable; otherwise, . - , such as , are defined in the object model as read-write. This is so those properties can be adjusted after initialization of the object itself. However, once the metadata is applied to a dependency property as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. At the time of one of these calls, is called, and the value of this property is set to `true`. - - - -## Examples - The following example checks prior to a set operation of a custom metadata property. - - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetmergeimpl"::: - + , such as , are defined in the object model as read-write. This is so those properties can be adjusted after initialization of the object itself. However, once the metadata is applied to a dependency property as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. At the time of one of these calls, is called, and the value of this property is set to `true`. + + + +## Examples + The following example checks prior to a set operation of a custom metadata property. + + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetmergeimpl"::: + ]]> @@ -436,25 +436,25 @@ The dependency property to which this metadata is being applied. Merges this metadata with the base metadata. - method). - - - -## Examples - The following example implements a merge for a custom metadata type that adds an additional property to the property metadata. - - :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetmergeimpl"::: - + method). + + + +## Examples + The following example implements a merge for a custom metadata type that adds an additional property to the property metadata. + + :::code language="csharp" source="~/snippets/csharp/System.Windows/FrameworkPropertyMetadata/.ctor/Class1.cs" id="Snippetmergeimpl"::: + ]]> - Class implementations that derive from should override this method to account for any metadata properties they have added in their implementations. For instance, your implementation might have added a new flagwise enumeration value, and the implementation should then be able to combine those flags correctly. - - Always call the base implementation prior to your implementation code, because the base implementation takes care of merging all the properties already defined on the type. - + Class implementations that derive from should override this method to account for any metadata properties they have added in their implementations. For instance, your implementation might have added a new flagwise enumeration value, and the implementation should then be able to combine those flags correctly. + + Always call the base implementation prior to your implementation code, because the base implementation takes care of merging all the properties already defined on the type. + The exact behavior of the merge is up to you. You could choose to have values combined, revert to base value if the derived metadata were left at the default, or many other behaviors based on the types of properties you have added to your particular metadata class, and their meanings. @@ -492,11 +492,11 @@ The type associated with this metadata if this is type-specific metadata. If this is default metadata, this value is a null reference. Called when this metadata has been applied to a property, which indicates that the metadata is being sealed. - subclass should be marked as immutable once is called. This will be called once the metadata is applied to a property system operation (register, add owner, override metadata). - + subclass should be marked as immutable once is called. This will be called once the metadata is applied to a property system operation (register, add owner, override metadata). + ]]> @@ -534,13 +534,13 @@ Gets or sets a reference to a implementation specified in this metadata. A implementation reference. - . The default merge logic for is to maintain all implementations in a table and call each of them, with callbacks established by the deepest class in hierarchy running first. - - is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. - + . The default merge logic for is to maintain all implementations in a table and call each of them, with callbacks established by the deepest class in hierarchy running first. + + is defined in the object model as read-write. This is so can be adjusted after initialization of the object itself. However, once the metadata is consumed as part of a call to , , or , the property system will seal that metadata instance and the properties are now considered immutable. Attempting to set once is `true` on this metadata instance will raise an exception. + ]]> Cannot set a metadata property once it is applied to a dependency property operation. diff --git a/xml/System.Windows/PropertyPath.xml b/xml/System.Windows/PropertyPath.xml index e20316e2e8a..f4f01b3eadb 100644 --- a/xml/System.Windows/PropertyPath.xml +++ b/xml/System.Windows/PropertyPath.xml @@ -33,7 +33,7 @@ , and list of dependency properties that are the into the string . + This class contains a string , and list of dependency properties that are the into the string . supports two modes of behavior: @@ -101,9 +101,9 @@ ## Remarks This constructor has two completely different usages depending on whether it is being used for a source-mode property path for a binding, or for a target-mode single-step property path for a storyboard target. - If using this in source mode for a binding, `parameter` is a string representing a property name, or can be a string that describes a "step-through" path to the property in the CLR object model of the object that is being used as the source for a binding. For a binding property path, the character that identifies a "step" is a dot (.). Indexer references (including multiple indexers, and type differentiation) are also supported. For more details on the syntax of the string as specifically used by the object, see . A property used as a binding source need not be a dependency property. If the binding updates two-way, the property referenced must be read-write. Also note that the binding target does have to be a dependency property. For details, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + If using this in source mode for a binding, `parameter` is a string representing a property name, or can be a string that describes a "step-through" path to the property in the CLR object model of the object that is being used as the source for a binding. For a binding property path, the character that identifies a "step" is a dot (.). Indexer references (including multiple indexers, and type differentiation) are also supported. For more details on the syntax of the string as specifically used by the object, see . A property used as a binding source need not be a dependency property. If the binding updates two-way, the property referenced must be read-write. Also note that the binding target does have to be a dependency property. For details, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - If using this in target mode for a single-step path for a storyboard target, `parameter` is generally provided as type . You can also specify a string that is the . Either of these evaluate to the same result, because it is stored internally as a string. A provided is converted to a string through . The supports a qualified naming format for dependency properties, so you can specify a *typeName*.*propertyName* qualified dependency property name string to the constructor in code. The qualified path to the dependency property identifier is a different concept than a complex path. A complex-path should instead be created with the constructor. + If using this in target mode for a single-step path for a storyboard target, `parameter` is generally provided as type . You can also specify a string that is the . Either of these evaluate to the same result, because it is stored internally as a string. A provided is converted to a string through . The supports a qualified naming format for dependency properties, so you can specify a *typeName*.*propertyName* qualified dependency property name string to the constructor in code. The qualified path to the dependency property identifier is a different concept than a complex path. A complex-path should instead be created with the constructor. ]]> @@ -153,7 +153,7 @@ This constructor supports `params` for the `pathParameters` constructor argument. Therefore you can specify the contents of `pathParameters` as a series of comma-separated constructor arguments that populate the array, rather than needing to dimension an array and then populate it with the `pathParameters` items. Each item you specify must be one of the following types: , , . - For more information on the requirements of the parameters, see and . + For more information on the requirements of the parameters, see and . ]]> @@ -197,11 +197,11 @@ ## Remarks The string contained in this property has three completely different meanings depending on whether a is being used for a source-mode property path for a binding, for a target-mode single-step property path for a storyboard target, or for a complex path for a storyboard target. - If using this in source mode for a binding, is a string representing a property name, or can be a string that describes a "step-through" path to the property in the CLR object model of the object that is being used as the source for a binding. For a binding property path, the character that identifies a "step" is a dot (.). Indexer references (including multiple indexers, and type differentiation) are also supported. For more details on the syntax of the string as specifically used by the object, see . A property used as a binding source need not be a dependency property. If the binding updates two-way, the property source must be read-write. Also note that the binding target does have to be a dependency property. For details, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + If using this in source mode for a binding, is a string representing a property name, or can be a string that describes a "step-through" path to the property in the CLR object model of the object that is being used as the source for a binding. For a binding property path, the character that identifies a "step" is a dot (.). Indexer references (including multiple indexers, and type differentiation) are also supported. For more details on the syntax of the string as specifically used by the object, see . A property used as a binding source need not be a dependency property. If the binding updates two-way, the property source must be read-write. Also note that the binding target does have to be a dependency property. For details, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). If using this in target mode for a single-step path for a storyboard target, is a string that is a *typeName*.*propertyName* qualified dependency property name string. - If using this for a complex path for a storyboard target, is a tokenized string format that describes the relationships of the various objects given in the . + If using this for a complex path for a storyboard target, is a tokenized string format that describes the relationships of the various objects given in the . - Each item in the array is specified in this format by the array index for the item enclosed in parentheses. For example, to specify the first item in the array, the string token is `(0)`. @@ -209,9 +209,9 @@ - Items within collection properties are accessed with an indexer syntax, with the index within square brackets ([ and ]). The indexer is additive to the token representing the property. For example, the following is a two-step path, with the token combination in the first step specifying the second item from within the collection of that property: `(0)[1].(1)` . You cannot use an indexer on the last property in the chain; you cannot animate the actual collection position, you must animate a property on that object. - The path string for a is typically established through the constructors: the signature for bindings or single-step storyboard targets, the signature for multi-step storyboard targets. + The path string for a is typically established through the constructors: the signature for bindings or single-step storyboard targets, the signature for multi-step storyboard targets. - **XAML:** When you use a to describe a property reference in XAML, as an attribute value, the string that you specify is first handled by a type converter (). This type converter then processes the string and based on its syntax will call one of the constructor signatures. This indirection through the type converter handling an attribute value is generally how you use in XAML, rather than declaring a object element and then applying specific values to attributes such as and . For more information, see [PropertyPath XAML Syntax](/dotnet/framework/wpf/advanced/propertypath-xaml-syntax). + **XAML:** When you use a to describe a property reference in XAML, as an attribute value, the string that you specify is first handled by a type converter (). This type converter then processes the string and based on its syntax will call one of the constructor signatures. This indirection through the type converter handling an attribute value is generally how you use in XAML, rather than declaring a object element and then applying specific values to attributes such as and . For more information, see [PropertyPath XAML Syntax](/dotnet/framework/wpf/advanced/propertypath-xaml-syntax). ## XAML Text Usage @@ -251,13 +251,13 @@ are typically established through the constructors. For setting , the constructor is particularly convenient because the `pathParameters` constructor argument is designated as `params`, meaning that you do not need to create or dimension an array for construction. You simply specify each member of the array as an additional parameter. + The properties for a are typically established through the constructors. For setting , the constructor is particularly convenient because the `pathParameters` constructor argument is designated as `params`, meaning that you do not need to create or dimension an array for construction. You simply specify each member of the array as an additional parameter. If the final property that is the target is a type, that value will be cloned. For details, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). The actual evaluation of the property chain is performed by the storyboard animation mechanisms. At the level, no validation is performed to make sure that the steps of the path connect at all. For instance, you can construct a property path that has as the first step, and as the second step. But such a property path would fail if actually applied as a target, because the Brush type that fills does not have a property. Invalid property paths fail silently. For more information, see [Storyboards Overview](/dotnet/framework/wpf/graphics-multimedia/storyboards-overview). - **XAML:** When you use a to describe a property reference in XAML, as an attribute value, the string that you specify is first handled by a type converter (). This type converter then processes the string and based on its syntax will call one of the constructor signatures. This indirection through the type converter handling an attribute value is generally how you use in XAML, rather than declaring a object element and then applying specific values to attributes such as and . For more information, see [PropertyPath XAML Syntax](/dotnet/framework/wpf/advanced/propertypath-xaml-syntax). + **XAML:** When you use a to describe a property reference in XAML, as an attribute value, the string that you specify is first handled by a type converter (). This type converter then processes the string and based on its syntax will call one of the constructor signatures. This indirection through the type converter handling an attribute value is generally how you use in XAML, rather than declaring a object element and then applying specific values to attributes such as and . For more information, see [PropertyPath XAML Syntax](/dotnet/framework/wpf/advanced/propertypath-xaml-syntax). ## XAML Text Usage diff --git a/xml/System.Windows/QueryContinueDragEventArgs.xml b/xml/System.Windows/QueryContinueDragEventArgs.xml index 766d3b55258..bba53dd7199 100644 --- a/xml/System.Windows/QueryContinueDragEventArgs.xml +++ b/xml/System.Windows/QueryContinueDragEventArgs.xml @@ -69,7 +69,7 @@ event sets the property to `Cancel` if the ESC key is pressed, and sets to `Drop` if the left, middle, or right mouse button is released. + By default, the event sets the property to `Cancel` if the ESC key is pressed, and sets to `Drop` if the left, middle, or right mouse button is released. ]]> diff --git a/xml/System.Windows/Rect.xml b/xml/System.Windows/Rect.xml index 3d3de4fac11..20aaf10980c 100644 --- a/xml/System.Windows/Rect.xml +++ b/xml/System.Windows/Rect.xml @@ -69,12 +69,12 @@ *width* - A non-negative value that represents the of the rectangle. + A non-negative value that represents the of the rectangle. *height* - A non-negative value that represents the of the rectangle. + A non-negative value that represents the of the rectangle. @@ -132,7 +132,7 @@ structure by using the constructor. + The following example shows how to create a new structure by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcreaterectexample2_csharp"::: @@ -172,7 +172,7 @@ structure by using the constructor. + The following example shows how to create a new structure by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcreaterectexample3_csharp"::: @@ -212,7 +212,7 @@ structure by using the constructor. + The following example shows how to create a new structure by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcreaterectexample4_csharp"::: @@ -252,7 +252,7 @@ structure by using the constructor. + The following example shows how to create a new structure by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcreaterectexample5_csharp"::: @@ -296,7 +296,7 @@ structure by using the constructor. + The following example shows how to create a new structure by using the constructor. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcreaterectexample6_csharp"::: @@ -340,7 +340,7 @@ and properties. + The y-axis value of the bottom of the rectangle is equal to the sum of the and properties. @@ -383,7 +383,7 @@ , + ). + The position of the bottom-left corner of the rectangle is equal to (, + ). @@ -426,7 +426,7 @@ + , + ). + The position of the bottom-right corner of the rectangle is equal to ( + , + ). @@ -483,7 +483,7 @@ method to determine if the rectangle contains the specified . + The following example shows how to use the method to determine if the rectangle contains the specified . :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcontainsexample1_csharp"::: @@ -526,7 +526,7 @@ method to determine if one rectangle is contained by another rectangle. + The following example shows how to use the method to determine if one rectangle is contained by another rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcontainsexample2_csharp"::: @@ -571,7 +571,7 @@ method to determine if the rectangle contains the point specified by the given x-coordinate and y-coordinate. + The following example shows how to use the method to determine if the rectangle contains the point specified by the given x-coordinate and y-coordinate. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetcontainsexample3_csharp"::: @@ -615,7 +615,7 @@ and are infinite values, processor operations are severely impaired by these operations. Comparisons involving these values will not affect application performance. + Avoid mathematical computations involving empty rectangles. Because both and are infinite values, processor operations are severely impaired by these operations. Comparisons involving these values will not affect application performance. ]]> @@ -676,7 +676,7 @@ ## Examples - The following example shows how to use the method to determine if a rectangle is equal to a specified object. + The following example shows how to use the method to determine if a rectangle is equal to a specified object. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetequalsexample1_csharp"::: @@ -731,7 +731,7 @@ ## Examples - The following example shows how to use the method to determine if a rectangle is equal to a specified rectangle. + The following example shows how to use the method to determine if a rectangle is equal to a specified rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetequalsexample1_csharp"::: @@ -788,7 +788,7 @@ ## Examples - The following example shows how to use the method to determine if one rectangle is equal to another. + The following example shows how to use the method to determine if one rectangle is equal to another. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetequalsexample2_csharp"::: @@ -829,12 +829,12 @@ , , , and property values. + This method creates a hash code by using the , , , and property values. ## Examples - The following example shows how to use the method to get the hash code of a . + The following example shows how to use the method to get the hash code of a . :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetgethashcodeexample_csharp"::: @@ -878,7 +878,7 @@ rectangle has a of . The rectangle is read-only; its cannot not be changed. + The rectangle has a of . The rectangle is read-only; its cannot not be changed. @@ -944,12 +944,12 @@ of the resulting rectangle is increased by twice the of the specified structure, because both the left and right sides of the rectangle are inflated. Likewise, the of the resulting rectangle is increased by twice the of the specified structure. + The of the resulting rectangle is increased by twice the of the specified structure, because both the left and right sides of the rectangle are inflated. Likewise, the of the resulting rectangle is increased by twice the of the specified structure. ## Examples - The following example shows how to use the method to increase the size of a rectangle. + The following example shows how to use the method to increase the size of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetinflateexample1_csharp"::: @@ -994,14 +994,14 @@ of the resulting rectangle is increased or decreased by twice the specified width offset, because it is applied to both the left and right sides of the rectangle. Likewise, the of the resulting rectangle is increased or decreased by twice the specified height. + The of the resulting rectangle is increased or decreased by twice the specified width offset, because it is applied to both the left and right sides of the rectangle. Likewise, the of the resulting rectangle is increased or decreased by twice the specified height. - If the specified width or height shrink the rectangle by more than its current or - giving the rectangle a negative area - the rectangle becomes the rectangle. + If the specified width or height shrink the rectangle by more than its current or - giving the rectangle a negative area - the rectangle becomes the rectangle. ## Examples - The following example shows how to use the method to change the size of a rectangle. + The following example shows how to use the method to change the size of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetinflateexample2_csharp"::: @@ -1047,12 +1047,12 @@ of the resulting rectangle is increased by twice the of the specified structure, because both the left and right sides of the rectangle are inflated. Likewise, the of the resulting rectangle is increased by twice the of the specified structure. + The of the resulting rectangle is increased by twice the of the specified structure, because both the left and right sides of the rectangle are inflated. Likewise, the of the resulting rectangle is increased by twice the of the specified structure. ## Examples - The following example shows how to use the method to change the size of a rectangle. + The following example shows how to use the method to change the size of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetinflateexample3_csharp"::: @@ -1101,14 +1101,14 @@ of the resulting rectangle is increased or decreased by twice the specified width offset, because it is applied to both the left and right sides of the rectangle. Likewise, the of the resulting rectangle is increased or decreased by twice the specified height. + The of the resulting rectangle is increased or decreased by twice the specified width offset, because it is applied to both the left and right sides of the rectangle. Likewise, the of the resulting rectangle is increased or decreased by twice the specified height. - If the specified width or height modifiers shrink the rectangle by more than its current or - giving the rectangle a negative area - this method returns . + If the specified width or height modifiers shrink the rectangle by more than its current or - giving the rectangle a negative area - this method returns . ## Examples - The following example shows how to use the method to change the size of a rectangle. + The following example shows how to use the method to change the size of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetinflateexample4_csharp"::: @@ -1161,12 +1161,12 @@ . + If no intersection exists, the current rectangle becomes . ## Examples - The following example shows how to use the method to find the intersection of two rectangles and store the result as a rectangle. + The following example shows how to use the method to find the intersection of two rectangles and store the result as a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetintersectexample1_csharp"::: @@ -1211,7 +1211,7 @@ method to find the intersection of two rectangles. + The following example shows how to use the method to find the intersection of two rectangles. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetintersectexample2_csharp"::: @@ -1255,7 +1255,7 @@ method to determine if two rectangles intersect. + The following example shows how to use the method to determine if two rectangles intersect. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetintersectswithexample_csharp"::: @@ -1294,7 +1294,7 @@ rectangle. For more information, see the property. + Do not use this property to test for zero area; a rectangle with zero area is not necessarily the rectangle. For more information, see the property. ]]> @@ -1381,7 +1381,7 @@ , ). + The position of the top-left corner of the rectangle is equal to (, ). @@ -1444,14 +1444,14 @@ ) is not allowed. + Calling this method on an empty rectangle () is not allowed. - Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. ## Examples - The following example shows how to use the method to change the position of a rectangle. + The following example shows how to use the method to change the position of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoffsetexample1_csharp"::: @@ -1495,14 +1495,14 @@ ) is not allowed. + Calling this method on an empty rectangle () is not allowed. - Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. + Note that calling the method will only have an effect if you can change the and properties directly. Because is a value type, if you reference a object by using a property or indexer, you get a copy of the object, not a reference to the object. If you attempt to change or on a property or indexer reference, a compiler error occurs. Similarly, calling on the property or indexer will not change the underlying object. If you want to change the value of a that is referenced as a property or indexer, create a new , modify its fields, and then assign the back to the property or indexer. ## Examples - The following example shows how to use the method to change the position of a rectangle. + The following example shows how to use the method to change the position of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoffsetexample2_csharp"::: @@ -1547,12 +1547,12 @@ ) is not allowed. + Calling this method with an empty rectangle () is not allowed. ## Examples - The following example shows how to use the method to change the position of a rectangle. + The following example shows how to use the method to change the position of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoffsetexample3_csharp"::: @@ -1600,12 +1600,12 @@ ) is not allowed. + Calling this method with an empty rectangle () is not allowed. ## Examples - The following example shows how to use the method to change the position of a rectangle. + The following example shows how to use the method to change the position of a rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoffsetexample4_csharp"::: @@ -1659,10 +1659,10 @@ > [!NOTE] > A rectangle's position and dimensions are described by values. Because values can lose precision when operated upon, a comparison between two values that are logically equal might fail. - The equivalent method for this operator is + The equivalent method for this operator is ## Examples - The following example shows how to use the operator to determine if two rectangles are exactly equal. + The following example shows how to use the operator to determine if two rectangles are exactly equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoverloadedequalityoperatorexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Rect/op_Equality/rectexample.vb" id="Snippetoverloadedequalityoperatorexample"::: @@ -1715,10 +1715,10 @@ > [!NOTE] > A rectangle's position and dimensions are described by values. Because values can lose precision when operated upon, a comparison between two values that are logically equal might fail. - The equivalent method for this operator is + The equivalent method for this operator is ## Examples - The following example shows how to use the operator to determine if two rectangles are not exactly equal. + The following example shows how to use the operator to determine if two rectangles are not exactly equal. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetoverloadedinequalityoperatorexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Rect/op_Equality/rectexample.vb" id="Snippetoverloadedinequalityoperatorexample"::: @@ -1761,7 +1761,7 @@ method to convert a string representation of a rectangle into a structure. + The following example shows how to use the method to convert a string representation of a rectangle into a structure. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetparseexample"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/Rect/op_Equality/rectexample.vb" id="Snippetparseexample"::: @@ -1800,7 +1800,7 @@ and properties. + The x-axis value of the right side of the rectangle is equal to the sum of the and properties. @@ -1848,7 +1848,7 @@ method to multiply the width and height of a rectangle by the specified amount. + The following example shows how to use the method to multiply the width and height of a rectangle by the specified amount. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetscaleexample_csharp"::: @@ -2043,7 +2043,7 @@ , ). + The position of the top-left corner of the rectangle is equal to (, ). @@ -2086,7 +2086,7 @@ + , ). + The position of the top-right corner of the rectangle is equal to ( + , ). @@ -2234,7 +2234,7 @@ method to transform a structure by using a . + The following example shows how to use the method to transform a structure by using a . :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippettransformexample1_csharp"::: @@ -2278,7 +2278,7 @@ method to create a new structure that results from applying a to an existing rectangle. + The following example shows how to use the method to create a new structure that results from applying a to an existing rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippettransformexample2_csharp"::: @@ -2328,7 +2328,7 @@ method to expand the current rectangle exactly enough to contain a given . + The following example shows how to use the method to expand the current rectangle exactly enough to contain a given . :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetunionexample1_csharp"::: @@ -2370,7 +2370,7 @@ method to expand the current rectangle exactly enough to contain the specified rectangle. + The following example shows how to use the method to expand the current rectangle exactly enough to contain the specified rectangle. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetunionexample2_csharp"::: @@ -2415,7 +2415,7 @@ method to create a rectangle that is exactly large enough to contain a given rectangle and a given . + The following example shows how to use the method to create a rectangle that is exactly large enough to contain a given rectangle and a given . :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetunionexample3_csharp"::: @@ -2460,7 +2460,7 @@ method to create a rectangle that is exactly large enough to contain two given rectangles. + The following example shows how to use the method to create a rectangle that is exactly large enough to contain two given rectangles. :::code language="csharp" source="~/snippets/csharp/System.Windows/Rect/Overview/RectExample1.cs" id="Snippetunionexample4_csharp"::: @@ -2505,7 +2505,7 @@ rectangle has a of . The rectangle is read-only; its cannot not be changed. + The rectangle has a of . The rectangle is read-only; its cannot not be changed. diff --git a/xml/System.Windows/RectConverter.xml b/xml/System.Windows/RectConverter.xml index 852bbd5919c..4a8b8d9cb68 100644 --- a/xml/System.Windows/RectConverter.xml +++ b/xml/System.Windows/RectConverter.xml @@ -165,11 +165,11 @@ Attempts to convert the specified object to a . The created from converting . - method. - + method. + ]]> The specified object is NULL or is a type that cannot be converted to a . @@ -212,22 +212,22 @@ Attempts to convert a to the specified type. The object created from converting this . - method. - + method. + ]]> - is . - + is . + -or- - - is not a . - + + is not a . + -or- - + The is not one of the valid types for conversion. diff --git a/xml/System.Windows/RequestBringIntoViewEventArgs.xml b/xml/System.Windows/RequestBringIntoViewEventArgs.xml index ea9b19173aa..1512ce90b9b 100644 --- a/xml/System.Windows/RequestBringIntoViewEventArgs.xml +++ b/xml/System.Windows/RequestBringIntoViewEventArgs.xml @@ -24,15 +24,15 @@ Provides data for the routed event. - event is raised by elements when you call from that element. Generally, this routed event is not handled by the source. Intermediate classes that do not implement scrollable regions or similar concepts that clip content should not handle the event. The event should be permitted to bubble to parent elements that implement a scrollable region or otherwise specify `false`. Such parent elements typically provide class handling for the event, which is where the necessary rendering logic occurs whenever a given element requests that it be made viewable within the clipping region. - - Content elements can cause the event to be raised by their content hosts (through calling and raising from the content host). Similarly, you can request logical tree elements to be brought into view with the helper method . - - A implements a related but different method . - + event is raised by elements when you call from that element. Generally, this routed event is not handled by the source. Intermediate classes that do not implement scrollable regions or similar concepts that clip content should not handle the event. The event should be permitted to bubble to parent elements that implement a scrollable region or otherwise specify `false`. Such parent elements typically provide class handling for the event, which is where the necessary rendering logic occurs whenever a given element requests that it be made viewable within the clipping region. + + Content elements can cause the event to be raised by their content hosts (through calling and raising from the content host). Similarly, you can request logical tree elements to be brought into view with the helper method . + + A implements a related but different method . + ]]> @@ -71,11 +71,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> @@ -114,11 +114,11 @@ Gets the object that should be made visible in response to the event. The object that called . - . - + . + ]]> @@ -157,11 +157,11 @@ Gets the rectangular region in the object's coordinate space which should be made visible. The requested rectangular space. - that was invoked to raise the event didn't specify a target rectangle, this property may be the value of the structure. - + that was invoked to raise the event didn't specify a target rectangle, this property may be the value of the structure. + ]]> diff --git a/xml/System.Windows/RequestBringIntoViewEventHandler.xml b/xml/System.Windows/RequestBringIntoViewEventHandler.xml index 2705438748f..d0d23bc425b 100644 --- a/xml/System.Windows/RequestBringIntoViewEventHandler.xml +++ b/xml/System.Windows/RequestBringIntoViewEventHandler.xml @@ -32,15 +32,15 @@ The event data. Represents the method that will handle the routed event. - . If you derive from , you can register a class handler for and supplement the base class handling of the event. You should also consider using or class-handling the class-defined event instead of . Alternatively, if you create an entirely custom class that does not derive from , you can still add class handling by calling in your class instantiation. For details on class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - - Content elements can cause the event to be raised by their content hosts (through calling and raising from the content host). Similarly, you can request logical tree elements to be brought into view with the helper method . - - A implements a related but different method . - + . If you derive from , you can register a class handler for and supplement the base class handling of the event. You should also consider using or class-handling the class-defined event instead of . Alternatively, if you create an entirely custom class that does not derive from , you can still add class handling by calling in your class instantiation. For details on class handling, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). + + Content elements can cause the event to be raised by their content hosts (through calling and raising from the content host). Similarly, you can request logical tree elements to be brought into view with the helper method . + + A implements a related but different method . + ]]> diff --git a/xml/System.Windows/ResourceDictionary.xml b/xml/System.Windows/ResourceDictionary.xml index 69808a52565..21d4aae557d 100644 --- a/xml/System.Windows/ResourceDictionary.xml +++ b/xml/System.Windows/ResourceDictionary.xml @@ -69,7 +69,7 @@ In Extensible Application Markup Language (XAML), the class is typically an implicit collection element that is the object element value of several `Resources` properties, when given in property element syntax. For details on implicit collections in XAML, see [XAML Syntax In Detail](/dotnet/framework/wpf/advanced/xaml-syntax-in-detail). An exception is when you want to specify a merged dictionary; for details, see [Merged Resource Dictionaries](/dotnet/framework/wpf/advanced/merged-resource-dictionaries). - Another possible XAML usage is to declare a resource dictionary as a discrete XAML file, and either load it at run time with or include it in a (full-trust) project as a resource or loose file. In this case, can be declared as an object element, serving as the root element of the XAML. You must map the appropriate XML namespace values (default for the WPF namespace and typically `x:` for the XAML namespace) onto the element if you plan to use it as the root element. Then you can add child elements that define the resources, each with an [x:Key](/dotnet/framework/xaml-services/x-key-directive) value. + Another possible XAML usage is to declare a resource dictionary as a discrete XAML file, and either load it at run time with or include it in a (full-trust) project as a resource or loose file. In this case, can be declared as an object element, serving as the root element of the XAML. You must map the appropriate XML namespace values (default for the WPF namespace and typically `x:` for the XAML namespace) onto the element if you plan to use it as the root element. Then you can add child elements that define the resources, each with an [x:Key](/dotnet/framework/xaml-services/x-key-directive) value. ## XAML Implicit Collection Usage @@ -161,7 +161,7 @@ ## Remarks Attempting to add a duplicate key raises an exception. - Keys are always added to the base dictionary. Keys in within the current are not checked for duplication, only the base dictionary is checked for duplicates. + Keys are always added to the base dictionary. Keys in within the current are not checked for duplication, only the base dictionary is checked for duplicates. ]]> @@ -202,9 +202,9 @@ are about to be loaded. The next step in the process is to call . + Calling this method is an indication that the contents of the are about to be loaded. The next step in the process is to call . - Do not call more than once, before calling . Doing so will raise an exception. + Do not call more than once, before calling . Doing so will raise an exception. ]]> @@ -244,7 +244,7 @@ collection and specifically call on that , although typically the dictionaries are remote and you might not have access. Alternatively, remove the entire from by calling Remove on the generic collection. + If you need to clear merged dictionary items, obtain the particular dictionary from collection and specifically call on that , although typically the dictionaries are remote and you might not have access. Alternatively, remove the entire from by calling Remove on the generic collection. ]]> @@ -331,7 +331,7 @@ if it is reconstituted to be a again. + This copies only the base dictionary. The result array will have no if it is reconstituted to be a again. ]]> @@ -441,7 +441,7 @@ and follow a transaction model. marks the dictionary uninitialized and marks it initialized. + and follow a transaction model. marks the dictionary uninitialized and marks it initialized. ]]> @@ -691,7 +691,7 @@ The invalidations happen when an implicit data template resource changes. by item or index is not generally the preferred way to retrieve resources. You should instead call methods that are capable of participating in the full resource lookup process and look up resources by their keys, and that can find the resources in applications or themes. is such a method, and is present on any . Otherwise your attempt to find the resource does not match the true run-time behavior. + Checking a by item or index is not generally the preferred way to retrieve resources. You should instead call methods that are capable of participating in the full resource lookup process and look up resources by their keys, and that can find the resources in applications or themes. is such a method, and is present on any . Otherwise your attempt to find the resource does not match the true run-time behavior. However, obtaining resources directly from an individual dictionary might be appropriate if you are retrieving resources from a known location, and are doing so to avoid the possible performance and scope implications of run-time key lookup. @@ -734,9 +734,9 @@ The invalidations happen when an implicit data template resource changes., but generally is not useful for most scenarios. + This property exists because it is required by , but generally is not useful for most scenarios. - The returned keys do not include keys within the . Also the keys collection is a snapshot of the keys in the base dictionary. If you subsequently make changes to this , a stored will not reflect the changes. + The returned keys do not include keys within the . Also the keys collection is a snapshot of the keys in the base dictionary. If you subsequently make changes to this , a stored will not reflect the changes. ]]> @@ -773,11 +773,11 @@ The invalidations happen when an implicit data template resource changes. to the generic collection referenced by . A merged does not have resource elements defined within it in markup. Instead, the merged dictionary is a with no markup child elements defined (or with no elements added through code), but with a URI specified for . The designation enables the merged dictionary to come from an external source, such as a separate resource assembly that ships with the application, "loose XAML", or a specific localization or global resources assembly. + Dictionaries are merged by adding a to the generic collection referenced by . A merged does not have resource elements defined within it in markup. Instead, the merged dictionary is a with no markup child elements defined (or with no elements added through code), but with a URI specified for . The designation enables the merged dictionary to come from an external source, such as a separate resource assembly that ships with the application, "loose XAML", or a specific localization or global resources assembly. - Specifying resource elements within a that has specified is not supported. + Specifying resource elements within a that has specified is not supported. - Lookup behavior within the collection will search the last-added first, and the search stops as soon as a requested key is found. Duplicate keys across the collection of merged dictionaries are not illegal. For more information on merged dictionary behavior, see [Merged Resource Dictionaries](/dotnet/framework/wpf/advanced/merged-resource-dictionaries). + Lookup behavior within the collection will search the last-added first, and the search stops as soon as a requested key is found. Duplicate keys across the collection of merged dictionaries are not illegal. For more information on merged dictionary behavior, see [Merged Resource Dictionaries](/dotnet/framework/wpf/advanced/merged-resource-dictionaries). ## XAML Property Element Usage @@ -794,7 +794,7 @@ The invalidations happen when an implicit data template resource changes. ## XAML Values *oneOrMoreResourceDictionaries* - One or more object elements. A used for does not have collection content, and specifies a attribute that references the complete remotely. + One or more object elements. A used for does not have collection content, and specifies a attribute that references the complete remotely. @@ -929,7 +929,7 @@ The invalidations happen when an implicit data template resource changes. does not contain an element with the specified key, the remains unchanged. No exception is raised. - This method does not remove keys from the . You must obtain the specific from the collection to remove those keys, but that might not be possible because you are typically accessing such a dictionary remotely. + This method does not remove keys from the . You must obtain the specific from the collection to remove those keys, but that might not be possible because you are typically accessing such a dictionary remotely. ]]> @@ -976,9 +976,9 @@ The invalidations happen when an implicit data template resource changes. is specified as a Pack URI, which references the location of a resource dictionary that is included as a noncompiled Resource or Content build action by your application building project. For details on the Pack URI format, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). + Typically, is specified as a Pack URI, which references the location of a resource dictionary that is included as a noncompiled Resource or Content build action by your application building project. For details on the Pack URI format, see [Pack URIs in WPF](/dotnet/framework/wpf/app-development/pack-uris-in-wpf). - Generally, the property is set only for a that is specified for the property (either as a property element in XAML, or as a item of the collection in code). In this context, setting the value for will merge the dictionary contents found at the supplied URI into the current . Any load failures will cause an exception to be thrown. + Generally, the property is set only for a that is specified for the property (either as a property element in XAML, or as a item of the collection in code). In this context, setting the value for will merge the dictionary contents found at the supplied URI into the current . Any load failures will cause an exception to be thrown. @@ -1273,7 +1273,7 @@ The invalidations happen when an implicit data template resource changes., but generally is not useful for most scenarios. - The returned values do not include values within the . Also the collection is a snapshot of the values in the base dictionary. If you subsequently make changes to this , a stored will not reflect the changes. + The returned values do not include values within the . Also the collection is a snapshot of the values in the base dictionary. If you subsequently make changes to this , a stored will not reflect the changes. ]]> diff --git a/xml/System.Windows/RoutedEvent.xml b/xml/System.Windows/RoutedEvent.xml index 17299562263..421f1cd2e29 100644 --- a/xml/System.Windows/RoutedEvent.xml +++ b/xml/System.Windows/RoutedEvent.xml @@ -45,7 +45,7 @@ , , , and properties. None of these members can have null values. + This class contains the , , , and properties. None of these members can have null values. This class has a XAML usage that is exclusively intended for providing the value of the property of an (or derived class), or for the property of an (or derived class). For more information about , , and the XAML usages for those classes, see [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). @@ -65,7 +65,7 @@ ## XAML Values *eventName* - An unqualified event name, equivalent to the property of the field, not the actual member name of the identifier field within a type. Without qualification, *eventName* must name an event as found in the type that is the of the current style containing the or . + An unqualified event name, equivalent to the property of the field, not the actual member name of the identifier field within a type. Without qualification, *eventName* must name an event as found in the type that is the of the current style containing the or . *type* The type to use to qualify the event name. If provided without a prefix, *type* is expected to be a type within the default XAML namespace, and that can be mapped to an existing CLR type. For custom events, or events that are on types outside of the default XAML namespace, the string for *type* can include a prefix for a mapped XAML namespace. That XAML namespace should contain the XAML type that can map to a backing CLR type, and that CLR type should define the desired routed event identifier. For details on XAML namespace mapping, see [XAML Namespaces and Namespace Mapping for WPF XAML](/dotnet/framework/wpf/advanced/xaml-namespaces-and-namespace-mapping-for-wpf-xaml). @@ -203,7 +203,7 @@ ## Remarks The name of a routed event must be unique within each owner type, but is not required to be globally unique. - The value of this property originates from the method that defines a . Specifically, the value of is the `name` parameter value that was passed to . + The value of this property originates from the method that defines a . Specifically, the value of is the `name` parameter value that was passed to . ]]> @@ -248,7 +248,7 @@ ## Remarks This type can be any object type, not necessarily limited to . In cases of routed events that have owners added, this property will return the first declared owner. - The value of this property originates from the method that defines a . Specifically, the value of is the `ownerType` parameter value that was passed to . + The value of this property originates from the method that defines a . Specifically, the value of is the `ownerType` parameter value that was passed to . ]]> @@ -293,7 +293,7 @@ ## Remarks By convention, tunneling routed events have the name prefix "Preview" and an associated bubbling event defined. It should be rare that there would be only a tunneling version and not a matching bubbling version. For more information, see [How to: Create a Custom Routed Event](/dotnet/framework/wpf/advanced/how-to-create-a-custom-routed-event). - The value of this property originates from the method that defines a . Specifically, the value of is the `routingStrategy` parameter value that was passed to . + The value of this property originates from the method that defines a . Specifically, the value of is the `routingStrategy` parameter value that was passed to . ]]> diff --git a/xml/System.Windows/RoutedEventArgs.xml b/xml/System.Windows/RoutedEventArgs.xml index 54ba08c9cda..efccac6d49e 100644 --- a/xml/System.Windows/RoutedEventArgs.xml +++ b/xml/System.Windows/RoutedEventArgs.xml @@ -27,7 +27,7 @@ can be used with a single . This class is responsible for packaging the event data for a , providing extra event state information, and is used by the event system for invoking the handler associated with the routed event. + Different can be used with a single . This class is responsible for packaging the event data for a , providing extra event state information, and is used by the event system for invoking the handler associated with the routed event. ]]> @@ -79,15 +79,15 @@ ## Remarks When using this parameterless constructor, all public properties of the new instance assume the following default values: -- defaults to `null`. +- defaults to `null`. -- defaults to `false` +- defaults to `false` -- defaults to `null`. +- defaults to `null`. -- defaults to `null`. +- defaults to `null`. - Null values for and only mean that the data makes no attempt to specify the source. When this instance is used in a call to , the and values are populated based on the element that raised the event and are passed on to listeners through the routing. + Null values for and only mean that the data makes no attempt to specify the source. When this instance is used in a call to , the and values are populated based on the element that raised the event and are passed on to listeners through the routing. ]]> @@ -132,18 +132,18 @@ ## Remarks When using this overloaded constructor, unspecified properties of the new instance assume the following default values: -- defaults to `false` +- defaults to `false` -- defaults to `null`. +- defaults to `null`. -- defaults to `null`. +- defaults to `null`. - Null values for and only mean that this makes no attempt to specify the source. When this instance is used in a call to , the and values are populated based on the element that raised the event and are passed on to listeners through the routing. + Null values for and only mean that this makes no attempt to specify the source. When this instance is used in a call to , the and values are populated based on the element that raised the event and are passed on to listeners through the routing. ## Examples - The following example constructs a new for use in a call to . + The following example constructs a new for use in a call to . :::code language="csharp" source="~/snippets/csharp/System.Windows/RoutedEventArgs/.ctor/class1.cs" id="Snippetraiseevent"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/RoutedEventCustom/VB/SDKSampleLibrary/Class1.vb" id="Snippetraiseevent"::: @@ -188,13 +188,13 @@ ## Remarks When using this overloaded constructor, unspecified properties of the new instance assume the following default values: -- defaults to `false` +- defaults to `false` -- defaults to `null`. +- defaults to `null`. - Null values for are populated based on the element that raised the event and passed on through the routing, but will read `null` prior to invocation. + Null values for are populated based on the element that raised the event and passed on through the routing, but will read `null` prior to invocation. - Use this signature when passing to virtuals such as , where the arguments are used to call internally. + Use this signature when passing to virtuals such as , where the arguments are used to call internally. ]]> @@ -242,11 +242,11 @@ method call will be invoked in response. Default handlers on instance listeners (such as those expressed in Extensible Application Markup Language (XAML)) will not be invoked. Handling events that are marked handled is not a common scenario. + Marking the event handled will limit the visibility of the routed event to listeners along the event route. The event does still travel the remainder of the route, but only handlers specifically added with `HandledEventsToo` `true` in the method call will be invoked in response. Default handlers on instance listeners (such as those expressed in Extensible Application Markup Language (XAML)) will not be invoked. Handling events that are marked handled is not a common scenario. If you are a control author defining your own events, the decisions you make regarding event handling at the class level will impact users of your control as well as any users of derived controls, and potentially other elements that are either contained by your control or that contain your control. For more information, see [Marking Routed Events as Handled, and Class Handling](/dotnet/framework/wpf/advanced/marking-routed-events-as-handled-and-class-handling). - In very rare circumstances it is appropriate to handle events where is marked `true`, and modify the event arguments by changing to `false`. This can be necessary in certain areas of input events of controls, such as key handling of versus where low level and high level input events compete for the handling, and each is attempting to work with a different routing strategy. + In very rare circumstances it is appropriate to handle events where is marked `true`, and modify the event arguments by changing to `false`. This can be necessary in certain areas of input events of controls, such as key handling of versus where low level and high level input events compete for the handling, and each is attempting to work with a different routing strategy. @@ -390,9 +390,9 @@ ## Remarks This property acquires its value once, before the class event handlers or any instance handlers are invoked, and is never adjusted past this point. The original source information is read-only to class handlers or class implementations, just as it is reported in the event data. - Common cases where the source may be adjusted include content elements inside a content model for a control (the contents of a list item, for instance, will report the list item element as the and the actual element within the list item will be the . + Common cases where the source may be adjusted include content elements inside a content model for a control (the contents of a list item, for instance, will report the list item element as the and the actual element within the list item will be the . - Source adjustment by various elements and content models varies from class to class. Each class that adjusts event sources attempts to anticipate which source is the most useful to report for most input scenarios and the scenarios for which the class is intended, and then sets that source as the . If this source is not the one that has relevance to your handling of the event, try checking instead to see if it reports a different source that is more suitable. For more details on input events, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + Source adjustment by various elements and content models varies from class to class. Each class that adjusts event sources attempts to anticipate which source is the most useful to report for most input scenarios and the scenarios for which the class is intended, and then sets that source as the . If this source is not the one that has relevance to your handling of the event, try checking instead to see if it reports a different source that is more suitable. For more details on input events, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview). ]]> @@ -437,12 +437,12 @@ ## Remarks You cannot set this value on a that has already been routed (for instance, if you obtained the arguments through a handler). Attempting to do so will generate an exception. You can only set it on an instance that has not yet been used to generate an invocation of the event. - The value of cannot be `null` at any time. + The value of cannot be `null` at any time. ## Examples - The following example creates new routed event data with an initial constructor and then sets the property as a subsequent operation. You must have set prior to raising the routed event. + The following example creates new routed event data with an initial constructor and then sets the property as a subsequent operation. You must have set prior to raising the routed event. :::code language="csharp" source="~/snippets/csharp/System.Windows/RoutedEventArgs/RoutedEvent/ColorPicker.cs" id="Snippetroutedeventargsroutedevent"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows/RoutedEventArgs/RoutedEvent/colorpicker.vb" id="Snippetroutedeventargsroutedevent"::: @@ -488,11 +488,11 @@ will be different than the value of the `sender` parameter of the event arguments class. Which of the two elements involved in the event is of the most importance in any given handler (, the element that raised it, or `sender`, the element that is currently handling it) is dependent on the application logic that your handler is addressing. + For any bubbling routed event that has actually traveled the route beyond the element that raised it, and for any tunneling routed event that has not yet tunneled down to the element that raised it, the value of will be different than the value of the `sender` parameter of the event arguments class. Which of the two elements involved in the event is of the most importance in any given handler (, the element that raised it, or `sender`, the element that is currently handling it) is dependent on the application logic that your handler is addressing. Setting this property is typically only done when overriding or implementing other APIs that adjust event sources, such as when class handling an event. Resetting apparent event sources from instance handlers is not recommended, particularly when the handler does not mark the event as handled. - If you do reset to report a different event source, will continue to report the source as first raised by the originating call. + If you do reset to report a different event source, will continue to report the source as first raised by the originating call. ]]> diff --git a/xml/System.Windows/RoutedEventHandler.xml b/xml/System.Windows/RoutedEventHandler.xml index 5c56057b7e9..6ed0506153f 100644 --- a/xml/System.Windows/RoutedEventHandler.xml +++ b/xml/System.Windows/RoutedEventHandler.xml @@ -32,19 +32,19 @@ The event data. Represents the method that will handle various routed events that do not have specific event data beyond the data that is common for all routed events. - delegate is used for any routed event that does not report event-specific information in the event data. There are many such routed events; prominent examples include and . - - The most noteworthy difference between writing a handler for a routed event as opposed to a general common language runtime (CLR) event is that the `sender` of the event (the element where the handler is attached and invoked) cannot be considered to necessarily be the source of the event. The source is reported as a property in the event data (). A difference between `sender` and is the result of the event being routed to different elements, during the traversal of the routed event through an element tree. - - You can use either `sender` or for an object reference if you are deliberately not interested in the routing behavior of a direct or bubbling routed event and you only intend to handle routed events on the elements where they are first raised. In this circumstance, `sender` and are the same object. - - If you do intend to take advantage of the inherent features of routed events and write your handlers accordingly, the two most important properties of the event data that you will work with when writing event handlers are and . - - For certain combinations of input events and WPF control classes, the element that raises the event is not the first element that has the opportunity to handle it. If the input event has a Preview version of the event, then the root of the element tree has first opportunity, can set to `true` in the shared event data, and can influence how the input event is reported to remaining elements in its event route. The Preview handling behavior can give the appearance that a particular routed event is not raised as expected. For more information, see [Preview Events](/dotnet/framework/wpf/advanced/preview-events) and [Input Overview](/dotnet/framework/wpf/advanced/input-overview). - + delegate is used for any routed event that does not report event-specific information in the event data. There are many such routed events; prominent examples include and . + + The most noteworthy difference between writing a handler for a routed event as opposed to a general common language runtime (CLR) event is that the `sender` of the event (the element where the handler is attached and invoked) cannot be considered to necessarily be the source of the event. The source is reported as a property in the event data (). A difference between `sender` and is the result of the event being routed to different elements, during the traversal of the routed event through an element tree. + + You can use either `sender` or for an object reference if you are deliberately not interested in the routing behavior of a direct or bubbling routed event and you only intend to handle routed events on the elements where they are first raised. In this circumstance, `sender` and are the same object. + + If you do intend to take advantage of the inherent features of routed events and write your handlers accordingly, the two most important properties of the event data that you will work with when writing event handlers are and . + + For certain combinations of input events and WPF control classes, the element that raises the event is not the first element that has the opportunity to handle it. If the input event has a Preview version of the event, then the root of the element tree has first opportunity, can set to `true` in the shared event data, and can influence how the input event is reported to remaining elements in its event route. The Preview handling behavior can give the appearance that a particular routed event is not raised as expected. For more information, see [Preview Events](/dotnet/framework/wpf/advanced/preview-events) and [Input Overview](/dotnet/framework/wpf/advanced/input-overview). + ]]> diff --git a/xml/System.Windows/RoutedEventHandlerInfo.xml b/xml/System.Windows/RoutedEventHandlerInfo.xml index d22a2b5705e..26bde871fb6 100644 --- a/xml/System.Windows/RoutedEventHandlerInfo.xml +++ b/xml/System.Windows/RoutedEventHandlerInfo.xml @@ -106,7 +106,7 @@ properties. The property is a delegate reference. Therefore, equivalence implies a duplicate reference to the same handler. + This implementation relies on value equivalence of the properties. The property is a delegate reference. Therefore, equivalence implies a duplicate reference to the same handler. ]]> diff --git a/xml/System.Windows/RoutedPropertyChangedEventArgs`1.xml b/xml/System.Windows/RoutedPropertyChangedEventArgs`1.xml index 582b7dacb08..f711f413a8b 100644 --- a/xml/System.Windows/RoutedPropertyChangedEventArgs`1.xml +++ b/xml/System.Windows/RoutedPropertyChangedEventArgs`1.xml @@ -28,13 +28,13 @@ The type of the dependency property that has changed. Provides data about a change in value to a dependency property as reported by particular routed events, including the previous and current value of the property that changed. - and properties also reflect these type constraints; thus you can use a common event data class for different property changed events without requiring different delegates for each possible property type. - - Routed events that reports a property change where the delegate incorporates this event data class include , where the type constraint (and old and new values passed in the arguments) is of type , and , where the type constraint is . - + and properties also reflect these type constraints; thus you can use a common event data class for different property changed events without requiring different delegates for each possible property type. + + Routed events that reports a property change where the delegate incorporates this event data class include , where the type constraint (and old and new values passed in the arguments) is of type , and , where the type constraint is . + ]]> @@ -77,11 +77,11 @@ Current value of the property at the time of the event. Initializes a new instance of the class, with provided old and new values. - @@ -117,11 +117,11 @@ Identifier of the routed event that this arguments class carries information for. Initializes a new instance of the class, with provided old and new values, and an event identifier. - @@ -158,11 +158,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> @@ -200,11 +200,11 @@ Gets the new value of a property as reported by a property changed event. The generic value. In a practical implementation of the , the generic type of this property is replaced with the constrained type of the implementation. - @@ -242,11 +242,11 @@ Gets the previous value of the property as reported by a property changed event. The generic value. In a practical implementation of the , the generic type of this property is replaced with the constrained type of the implementation. - constructor's type arguments. - + constructor's type arguments. + ]]> diff --git a/xml/System.Windows/RoutedPropertyChangedEventHandler`1.xml b/xml/System.Windows/RoutedPropertyChangedEventHandler`1.xml index 1242b4c06c0..85c44bdb766 100644 --- a/xml/System.Windows/RoutedPropertyChangedEventHandler`1.xml +++ b/xml/System.Windows/RoutedPropertyChangedEventHandler`1.xml @@ -36,26 +36,26 @@ The event data. Specific event definitions will constrain to a type, with the type parameter of the constraint matching the type parameter constraint of a delegate implementation. Represents methods that will handle various routed events that track property value changes. - include and . - - - -## Examples - The following example defines and attaches a handler method for the event. - - The handler is based on , and is defined in the second segment of the code example, with the type parameter of the generic constrained to . - + include and . + + + +## Examples + The following example defines and attaches a handler method for the event. + + The handler is based on , and is defined in the second segment of the code example, with the type parameter of the generic constrained to . + :::code language="csharp" source="~/snippets/csharp/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/Window1.xaml.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/window1.xaml.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/window1.xaml.vb" id="Snippet2"::: + :::code language="csharp" source="~/snippets/csharp/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/Window1.xaml.cs" id="Snippetroutedpropertychangedevent"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/window1.xaml.vb" id="Snippetroutedpropertychangedevent"::: - - This particular example does not use the routed-event characteristic of the event; the event is handled on the same element that it is raised on. This is not always the case. For a routed event, it is possible that the source of the event is a different object than the object where the handler is attached. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows/RoutedPropertyChangedEventHandlerT/Overview/window1.xaml.vb" id="Snippetroutedpropertychangedevent"::: + + This particular example does not use the routed-event characteristic of the event; the event is handled on the same element that it is raised on. This is not always the case. For a routed event, it is possible that the source of the event is a different object than the object where the handler is attached. + ]]> diff --git a/xml/System.Windows/Setter.xml b/xml/System.Windows/Setter.xml index 1eb670871f7..b3924ba04bd 100644 --- a/xml/System.Windows/Setter.xml +++ b/xml/System.Windows/Setter.xml @@ -48,9 +48,9 @@ ## Remarks s and the different types of triggers (classes that inherit from ) use s to apply property values. -You must specify both the and properties on a for the setter to be meaningful. In .NET 8 and earlier versions, an exception is thrown if one or both properties aren't set. +You must specify both the and properties on a for the setter to be meaningful. In .NET 8 and earlier versions, an exception is thrown if one or both properties aren't set. - **Content Model:** In .NET 9 and later versions, the content property for is , and it's optional to specify as an attribute. + **Content Model:** In .NET 9 and later versions, the content property for is , and it's optional to specify as an attribute. @@ -215,7 +215,7 @@ You must specify both the and and properties on a or an exception will be thrown. + Note that you must specify both the and properties on a or an exception will be thrown. @@ -224,7 +224,7 @@ You must specify both the and property of a . Note that property name in this example is qualified with the name of the class () because the does not specify a . + The following example shows a style declaration that will affect the property of a . Note that property name in this example is qualified with the name of the class () because the does not specify a . :::code language="xaml" source="~/snippets/csharp/System.Windows/Setter/Property/Page1.xaml" id="Snippetstylesimple"::: @@ -445,7 +445,7 @@ You must specify both the and is used for the trigger to specify that the is intended for the named `ThumbCover` within the . + In the following example, the is used for the trigger to specify that the is intended for the named `ThumbCover` within the . :::code language="xaml" source="~/snippets/csharp/System.Windows/Setter/TargetName/ColorPickerApp/MyApp.xaml" id="Snippetstyletargetnameref"::: @@ -527,7 +527,7 @@ You must specify both the and and properties on a or an exception will be thrown. + Note that you must specify both the and properties on a or an exception will be thrown. Data binding and dynamic resources within the object is supported if the specified value is a object. See [Binding Markup Extension](/dotnet/framework/wpf/advanced/binding-markup-extension) and [DynamicResource Markup Extension](/dotnet/framework/wpf/advanced/dynamicresource-markup-extension). diff --git a/xml/System.Windows/Size.xml b/xml/System.Windows/Size.xml index 7f2a3d29134..5b8eeda4fc1 100644 --- a/xml/System.Windows/Size.xml +++ b/xml/System.Windows/Size.xml @@ -46,7 +46,7 @@ is particularly useful because it describes both the and of an object. is used extensively by the layout system to arrange and measure elements. + is particularly useful because it describes both the and of an object. is used extensively by the layout system to arrange and measure elements. ## XAML Attribute Usage @@ -58,10 +58,10 @@ ## XAML Values *width* - A value greater than or equal to 0 that specifies the of the structure. + A value greater than or equal to 0 that specifies the of the structure. *height* - A value greater than or equal to 0 that specifies the of the structure. + A value greater than or equal to 0 that specifies the of the structure. @@ -151,7 +151,7 @@ and of the instance of are equal to negative-infinity when this property is invoked. This is the only situation where can be a negative number. + The and of the instance of are equal to negative-infinity when this property is invoked. This is the only situation where can be a negative number. ]]> @@ -664,7 +664,7 @@ property is set to 30 and the property is set to 40, the method returns a string that says `"30, 40"`. + If the property is set to 30 and the property is set to 40, the method returns a string that says `"30, 40"`. ]]> diff --git a/xml/System.Windows/SizeChangedEventArgs.xml b/xml/System.Windows/SizeChangedEventArgs.xml index b4b8f097321..a0ec363eeb6 100644 --- a/xml/System.Windows/SizeChangedEventArgs.xml +++ b/xml/System.Windows/SizeChangedEventArgs.xml @@ -56,13 +56,13 @@ if the component of the size changed; otherwise, . - precision numbers process imprecisely, this property might return a value of `false` even when and are not equal. - - The layout system occasionally experiences this state due to minor fluctuations in the input parameters; however, the overall rendered scene is considered to be the same; therefore, no visible changes are detected. The handler for the event should check for this state in order to avoid invalidation of layout if the dimension didn't actually change. - + precision numbers process imprecisely, this property might return a value of `false` even when and are not equal. + + The layout system occasionally experiences this state due to minor fluctuations in the input parameters; however, the overall rendered scene is considered to be the same; therefore, no visible changes are detected. The handler for the event should check for this state in order to avoid invalidation of layout if the dimension didn't actually change. + ]]> @@ -101,11 +101,11 @@ The target to call the handler on. Invokes event handlers in a type-specific way, which can increase event system efficiency. - and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). - + and then invokes it. For details on this implementation pattern and the reasons for it, see and [Routed Events Overview](/dotnet/framework/wpf/advanced/routed-events-overview). + ]]> @@ -209,13 +209,13 @@ if the component of the size changed; otherwise, . - precision numbers process imprecisely, this property might return a value of `false` even when and are not equal. - - The layout system occasionally experiences this state due to minor fluctuations in the input parameters; however, the overall rendered scene is considered to be the same; therefore, no visible changes are detected. The handler for the event should check for this state in order to avoid invalidation of layout if the dimension didn't actually change. - + precision numbers process imprecisely, this property might return a value of `false` even when and are not equal. + + The layout system occasionally experiences this state due to minor fluctuations in the input parameters; however, the overall rendered scene is considered to be the same; therefore, no visible changes are detected. The handler for the event should check for this state in order to avoid invalidation of layout if the dimension didn't actually change. + ]]> diff --git a/xml/System.Windows/SizeChangedInfo.xml b/xml/System.Windows/SizeChangedInfo.xml index 048ec70395a..0d488e58d9c 100644 --- a/xml/System.Windows/SizeChangedInfo.xml +++ b/xml/System.Windows/SizeChangedInfo.xml @@ -24,11 +24,11 @@ Report the specifics of a value change involving a . This is used as a parameter in overrides. - class, which is used to report event data for , but the two classes serve different purposes. is specifically used for overrides, which offers class handling for an event that is not exposed as a public event in WPF. For details, see . - + class, which is used to report event data for , but the two classes serve different purposes. is specifically used for overrides, which offers class handling for an event that is not exposed as a public event in WPF. For details, see . + ]]> @@ -74,11 +74,11 @@ if the Height component of the size changed. Initializes a new instance of the class. - @@ -117,11 +117,11 @@ if there is a significant Height component change; otherwise, . - constructor. - + constructor. + ]]> @@ -153,11 +153,11 @@ Gets the new size being reported. The new size. - constructor. - + constructor. + ]]> @@ -196,11 +196,11 @@ Gets the previous size of the size-related value being reported as changed. The previous size. - @@ -240,11 +240,11 @@ if the width changed; otherwise, . - constructor. - + constructor. + ]]> diff --git a/xml/System.Windows/SourceChangedEventArgs.xml b/xml/System.Windows/SourceChangedEventArgs.xml index d9443905eab..1cbe8e7abd1 100644 --- a/xml/System.Windows/SourceChangedEventArgs.xml +++ b/xml/System.Windows/SourceChangedEventArgs.xml @@ -24,13 +24,13 @@ Provides data for the SourceChanged event, used for interoperation. This class cannot be inherited. - subclass (currently, the only such class is ). When implementing an interoperation solution, you can attach or remove handlers for the event (by calling and , respectively) but you cannot perform other operations normally available to routed events such as class handling, adding owners, or raising the event from an arbitrary element source. - - This class overrides the virtual method , in order to return a type-specific handler when requested by the event system. This override does not appear in the class members table in this SDK documentation because it is a protected member implemented by a sealed class. - + subclass (currently, the only such class is ). When implementing an interoperation solution, you can attach or remove handlers for the event (by calling and , respectively) but you cannot perform other operations normally available to routed events such as class handling, adding owners, or raising the event from an arbitrary element source. + + This class overrides the virtual method , in order to return a type-specific handler when requested by the event system. This override does not appear in the class members table in this SDK documentation because it is a protected member implemented by a sealed class. + ]]> diff --git a/xml/System.Windows/SourceChangedEventHandler.xml b/xml/System.Windows/SourceChangedEventHandler.xml index adba7096c1b..4ddfbd46caf 100644 --- a/xml/System.Windows/SourceChangedEventHandler.xml +++ b/xml/System.Windows/SourceChangedEventHandler.xml @@ -32,13 +32,13 @@ The event data. Represents the method that will handle the "SourceChanged" event on specific listener elements. - in the event data are always the same object. You can add and remove handlers to this event despite the private access level of the event itself by using the public methods and . - - The `sender` of the event will be a derived class of . - + in the event data are always the same object. You can add and remove handlers to this event despite the private access level of the event itself by using the public methods and . + + The `sender` of the event will be a derived class of . + ]]> diff --git a/xml/System.Windows/SplashScreen.xml b/xml/System.Windows/SplashScreen.xml index 848ab4441e2..47f39beca5f 100644 --- a/xml/System.Windows/SplashScreen.xml +++ b/xml/System.Windows/SplashScreen.xml @@ -33,7 +33,7 @@ class to show an image in a startup window, or *splash screen*, when a WPF application starts. Call the method to display the splash screen. Call the method to close the splash screen. Specify the image to use in the constructor. + Use the class to show an image in a startup window, or *splash screen*, when a WPF application starts. Call the method to display the splash screen. Call the method to close the splash screen. Specify the image to use in the constructor. The class can display any image format that is supported by the Windows Imaging Component (WIC). For example, you can use the BMP, GIF, JPEG, PNG, or TIFF format. If the image is a PNG file and it includes an alpha channel, the image is rendered using the transparency defined in the alpha channel. @@ -203,7 +203,7 @@ method with the `autoClose` parameter set to `true`, you do not have to call the method. The splash screen will close automatically after the application is loaded. When the splash screen closes, the length of time it will take for it to fade is determined by the default value for the `fadeoutDuration` parameter, which is 300 milliseconds. + If you called the method with the `autoClose` parameter set to `true`, you do not have to call the method. The splash screen will close automatically after the application is loaded. When the splash screen closes, the length of time it will take for it to fade is determined by the default value for the `fadeoutDuration` parameter, which is 300 milliseconds. ]]> @@ -264,9 +264,9 @@ method with `autoClose` set to `true`, you do not have to call the method. The splash screen will close automatically after the application is loaded. When the splash screen closes, the length of time it will take for it to fade is determined by the default value for the `fadeoutDuration` parameter, which is 300 milliseconds. + If you call the method with `autoClose` set to `true`, you do not have to call the method. The splash screen will close automatically after the application is loaded. When the splash screen closes, the length of time it will take for it to fade is determined by the default value for the `fadeoutDuration` parameter, which is 300 milliseconds. - Call the method with `autoClose` set to `false` when you want to provide a non-default value for the fade duration. You will have to call the method to close the splash screen. + Call the method with `autoClose` set to `false` when you want to provide a non-default value for the fade duration. You will have to call the method to close the splash screen. ]]> diff --git a/xml/System.Windows/StrokeCollectionConverter.xml b/xml/System.Windows/StrokeCollectionConverter.xml index ebb8ca37de9..a0eb42d4365 100644 --- a/xml/System.Windows/StrokeCollectionConverter.xml +++ b/xml/System.Windows/StrokeCollectionConverter.xml @@ -182,7 +182,7 @@ method returns `null` if `value` is not a . + The method returns `null` if `value` is not a . @@ -244,9 +244,9 @@ method returns `null` if `value` is not a , or if `destinationType` is not or . + The method returns `null` if `value` is not a , or if `destinationType` is not or . - The method returns a base-64, encoded Ink Serialized Format (ISF). It is useful to store ink data as base-64, encoded ISF when it is not possible to store raw byte data, such as in Web pages. + The method returns a base-64, encoded Ink Serialized Format (ISF). It is useful to store ink data as base-64, encoded ISF when it is not possible to store raw byte data, such as in Web pages. ]]> diff --git a/xml/System.Windows/Style.xml b/xml/System.Windows/Style.xml index 02d65f503b0..232c20fd4bb 100644 --- a/xml/System.Windows/Style.xml +++ b/xml/System.Windows/Style.xml @@ -58,9 +58,9 @@ on any element that derives from or . A style is most commonly declared as a resource inside the section. Because styles are resources, they obey the same scoping rules that apply to all resources, so where you declare a style affects where it can be applied. If, for instance, you declare the style in the root element of your application definition XAML file, the style can be used anywhere in your application. If you are creating a navigation application and declare the style in one of the application's XAML files, the style can be used only in that XAML file. For more information on scoping rules for resources, see [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). + You can set a on any element that derives from or . A style is most commonly declared as a resource inside the section. Because styles are resources, they obey the same scoping rules that apply to all resources, so where you declare a style affects where it can be applied. If, for instance, you declare the style in the root element of your application definition XAML file, the style can be used anywhere in your application. If you are creating a navigation application and declare the style in one of the application's XAML files, the style can be used only in that XAML file. For more information on scoping rules for resources, see [XAML Resources](/dotnet/framework/wpf/advanced/xaml-resources). - The style declaration consists of a object that contains a collection of one or more objects. Each consists of a and a . The property is the name of the property of the element the style is to apply to. After the style is declared as a resource, it can then be referenced just like any other resource. + The style declaration consists of a object that contains a collection of one or more objects. Each consists of a and a . The property is the name of the property of the element the style is to apply to. After the style is declared as a resource, it can then be referenced just like any other resource. > [!NOTE] > If there is more than one setter in the setter collection with the same property value, the setter that is declared last is used. Similarly, if you set a value for the same property in a style and on an element directly, the value set on the element directly takes precedence. @@ -95,7 +95,7 @@ > [!NOTE] > Many WPF controls consist of a combination of other WPF controls, so creating a style that applies to all controls of a type can have broad impact. For instance, if you create a style that targets the controls in a , the style is applied to all controls in the canvas, even if the is part of another control, such as a . - For information on how to extend or inherit from a defined style, see the page. + For information on how to extend or inherit from a defined style, see the page. ]]> @@ -138,7 +138,7 @@ and style type. If this is used outside the context of the parser, behavior is undefined. + This constructor call requires delayed validation of and style type. If this is used outside the context of the parser, behavior is undefined. ]]> @@ -244,7 +244,7 @@ value. + Each style only supports one value. ## XAML Attribute Usage @@ -261,7 +261,7 @@ ## Examples - There are several ways that styles in WPF can be extended or inherited. Styles can be based on other styles through this property. When you use this property, the new style will inherit the values of the original style that are not explicitly redefined in the new style. In the following example, `Style2` inherits the value of `Yellow`, and adds a value of `Blue`. + There are several ways that styles in WPF can be extended or inherited. Styles can be based on other styles through this property. When you use this property, the new style will inherit the values of the original style that are not explicitly redefined in the new style. In the following example, `Style2` inherits the value of `Yellow`, and adds a value of `Blue`. :::code language="xaml" source="~/snippets/csharp/System.Windows/Setter/Property/Page1.xaml" id="Snippetextendingstyle"::: @@ -522,7 +522,7 @@ ## Remarks The property of a object can consist only of objects assignable to . Adding a child to a object implicitly adds it to the for the object. - An explicit property element usage for is also relatively common. This is a markup style decision that can sometimes help distinguish from and items in a complex style. For example: + An explicit property element usage for is also relatively common. This is a markup style decision that can sometimes help distinguish from and items in a complex style. For example: ```xaml