Skip to content

Commit a4d0540

Browse files
mairawRon Petrusha
authored andcommitted
fix reference enum field - Part 5 (#3094)
* fix reference enum field * Apply suggestions from docs review Co-Authored-By: Ron Petrusha <[email protected]> * Apply suggestions from docs review 2 * feedback * fix broken link
1 parent 66b62c1 commit a4d0540

19 files changed

+114
-114
lines changed

xml/System.Windows.Media/BitmapScalingMode.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
<format type="text/markdown"><![CDATA[
2020
2121
## Remarks
22-
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. This frame rate degradation can cause animations to skip frames or stutter. By setting the <xref:System.Windows.Media.RenderOptions.BitmapScalingMode%2A> property of the <xref:System.Windows.Media.RenderOptions> object to LowQuality you can create a smoother animation when scaling a bitmap.
22+
When animating the scale of any bitmap, the default high-quality image resampling algorithm can sometimes consume sufficient system resources to cause frame rate degradation. This frame rate degradation can cause animations to skip frames or stutter. By setting the <xref:System.Windows.Media.RenderOptions.BitmapScalingMode%2A?displayProperty=nameWithType> property to `LowQuality`, you can create a smoother animation when scaling a bitmap.
2323
2424
2525
2626
## Examples
27-
The following example shows how to set the <xref:System.Windows.Media.BitmapScalingMode.LowQuality> for an image object.
27+
The following example shows how to use the <xref:System.Windows.Media.RenderOptions.SetBitmapScalingMode%2A?displayProperty=nameWithType> method to set the bitmap scale mode to `LowQuality` for an image object:
2828
2929
[!code-csharp[RenderOptions#RenderOptionsSnippet2](~/samples/snippets/csharp/VS_Snippets_Wpf/RenderOptions/CSharp/Window1.xaml.cs#renderoptionssnippet2)]
3030
[!code-vb[RenderOptions#RenderOptionsSnippet2](~/samples/snippets/visualbasic/VS_Snippets_Wpf/RenderOptions/visualbasic/window1.xaml.vb#renderoptionssnippet2)]

xml/System.Windows.Media/EdgeMode.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
<format type="text/markdown"><![CDATA[
2020
2121
## Remarks
22-
Text objects are always displayed by using anti aliasing, and are not affected by setting the edge mode value. The default value for non-text drawing primitives, such as <xref:System.Windows.Shapes.Ellipse> and <xref:System.Windows.Shapes.Polygon>, is Unspecified.
22+
Text objects are always displayed by using anti aliasing and are not affected by setting the edge mode value. The default value for non-text drawing primitives, such as <xref:System.Windows.Shapes.Ellipse> and <xref:System.Windows.Shapes.Polygon>, is `Unspecified`.
2323
24-
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 <xref:System.Windows.Media.EdgeMode.Unspecified> value.
24+
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.
2525
2626
2727
2828
## Examples
29-
The following example shows how to use the <xref:System.Windows.Media.RenderOptions.SetEdgeMode%2A> method to set the edge mode for a drawing primitive to Aliased.
29+
The following example shows how to use the <xref:System.Windows.Media.RenderOptions.SetEdgeMode%2A?displayProperty=nameWithType> method to set the edge mode for a drawing primitive to `Aliased`:
3030
3131
[!code-csharp[VisualSnippets#SetEdgeMode](~/samples/snippets/csharp/VS_Snippets_Wpf/VisualSnippets/CSharp/Snippets.cs#setedgemode)]
3232
[!code-vb[VisualSnippets#SetEdgeMode](~/samples/snippets/visualbasic/VS_Snippets_Wpf/VisualSnippets/visualbasic/snippets.vb#setedgemode)]

xml/System.Windows.Media/HitTestFilterBehavior.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@
1919
<format type="text/markdown"><![CDATA[
2020
2121
## Remarks
22-
The return value of the hit test filter callback is a <xref:System.Windows.Media.HitTestFilterBehavior>, which determines what type of action should be taken when processing the visual tree for hit testing. For example, if your hit test filter callback return the value, ContinueSkipSelfAndChildren, you can remove the current visual object and its descendants from the hit test results evaluation.
22+
The return value of the hit test filter callback is a `HitTestFilterBehavior`, which determines what type of action should be taken when processing the visual tree for hit testing. For example, if your hit test filter callback returns the value `ContinueSkipSelfAndChildren`, you can remove the current visual object and its descendants from the hit test results evaluation.
2323
2424
> [!NOTE]
25-
> Pruning the visual tree of objects decreases the amount of processing that is required during the hit test results evaluation pass.
26-
27-
![Pruning a visual tree using a hit test filter](~/add/media/filteredvisualtree-01.png "Pruning a visual tree using a hit test filter")
25+
> Pruning the visual tree of objects decreases the amount of processing that is required during the hit test results evaluation pass.
26+
>
27+
> ![Pruning a visual tree using a hit test filter](~/add/media/filteredvisualtree-01.png "Pruning a visual tree using a hit test filter")
2828
Pruning a visual tree
2929
3030
3131
3232
## Examples
33-
The following example shows how to return a <xref:System.Windows.Media.HitTestFilterBehavior.ContinueSkipSelfAndChildren> value from a hit test filter callback method. In this case, the filter skips labels and their descendants and hit tests everything else.
33+
The following example shows how to return a `HitTestFilterBehavior` value from a hit test filter callback method. In this case, the filter skips labels and their descendants and hit tests everything else.
3434
3535
[!code-csharp[HitTestingOverview#106](~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestingOverview/CSharp/Window1.xaml.cs#106)]
3636
[!code-vb[HitTestingOverview#106](~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestingOverview/visualbasic/window1.xaml.vb#106)]

xml/System.Windows.Media/HitTestResultBehavior.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
<format type="text/markdown"><![CDATA[
2020
2121
## Remarks
22-
A hit test results callback method defines the actions that 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 <xref:System.Windows.Media.HitTestResultBehavior> value that determines whether to continue the enumeration of any other visual objects.
22+
A hit test results callback method defines the actions that 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 `HitTestResultBehavior` value that determines whether to continue the enumeration of any other visual objects.
2323
24-
You can enumerate all visual objects in a visual tree whose geometry contains a specified coordinate value. By returning Continue in your hit test callback method, you can identify all visual objects that are hit, even those that may be partly or wholly obscured by other visual objects.
24+
You can enumerate all visual objects in a visual tree whose geometry contains a specified coordinate value. By returning `Continue` in your hit test callback method, you can identify all visual objects that are hit, even those that may be partly or wholly obscured by other visual objects.
2525
2626
2727
2828
## Examples
29-
The following example shows how to return a <xref:System.Windows.Media.HitTestResultBehavior.Continue> value from a hit test results callback method.
29+
The following example shows how to return a `HitTestResultBehavior` value from a hit test results callback method.
3030
3131
[!code-csharp[HitTestingOverview#102](~/samples/snippets/csharp/VS_Snippets_Wpf/HitTestingOverview/CSharp/Window1.xaml.cs#102)]
3232
[!code-vb[HitTestingOverview#102](~/samples/snippets/visualbasic/VS_Snippets_Wpf/HitTestingOverview/visualbasic/window1.xaml.vb#102)]

xml/System.Windows.Threading/DispatcherPriority.xml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
<format type="text/markdown"><![CDATA[
2020
2121
## Remarks
22-
There is no specific system state or "idleness" corresponding to ApplicationIdle and ContextIdle in the current version of [!INCLUDE[TLA2#tla_winclient](~/includes/tla2sharptla-winclient-md.md)]. Both are still valid priorities; therefore, an operation with a priority of ContextIdle has a higher priority than an operation with a priority of SystemIdle.
22+
There is no specific system state or "idleness" corresponding to `ApplicationIdle` and `ContextIdle` in the current version of WPF. Both are still valid priorities; an operation with a priority of `ContextIdle` has a higher priority than an operation with a priority of `SystemIdle`.
2323
24-
The <xref:System.Windows.Threading.DispatcherPriority.ApplicationIdle> does not throttle the execution of an operation if it exceeds a certain percentage of the CPU. One way to throttle a process it to use a timer.
24+
The <xref:System.Windows.Threading.Dispatcher> does not throttle the execution of an operation if it exceeds a certain percentage of the CPU. One way to throttle a process it to use a timer.
2525
26-
If an operation is posted using <xref:System.Windows.Threading.Dispatcher.Invoke%2A> on its own <xref:System.Windows.Threading.DispatcherPriority.ContextIdle> at a priority of Send, the operation bypasses the queue and is immediately executed.
26+
If an operation is posted using <xref:System.Windows.Threading.Dispatcher.Invoke%2A?displayProperty=nameWithType> on its own <xref:System.Windows.Threading.Dispatcher> at a priority of `Send`, the operation bypasses the queue and is immediately executed.
2727
2828
## Examples
29-
The following example is a call to <xref:System.Windows.Threading.Dispatcher.BeginInvoke%2A> that passes a delegate which accepts an argument. The priority is set to Normal.
29+
The following example calls the <xref:System.Windows.Threading.Dispatcher.BeginInvoke%2A?displayProperty=nameWithType> method and passes it a delegate with one argument. The priority is set to `Normal`.
3030
3131
[!code-csharp[ThreadingWeatherForecast#ThreadingWeatherDispatcherOneArge](~/samples/snippets/csharp/VS_Snippets_Wpf/ThreadingWeatherForecast/CSharp/Window1.xaml.cs#threadingweatherdispatcheronearge)]
3232
[!code-vb[ThreadingWeatherForecast#ThreadingWeatherDispatcherOneArge](~/samples/snippets/visualbasic/VS_Snippets_Wpf/ThreadingWeatherForecast/visualbasic/window1.xaml.vb#threadingweatherdispatcheronearge)]
@@ -53,7 +53,7 @@
5353
</ReturnValue>
5454
<MemberValue>2</MemberValue>
5555
<Docs>
56-
<summary>The enumeration value is 2. Operations are processed when the application is idle.</summary>
56+
<summary>The enumeration value is 2. Operations are processed when the application is idle.</summary>
5757
</Docs>
5858
</Member>
5959
<Member MemberName="Background">
@@ -74,7 +74,7 @@
7474
</ReturnValue>
7575
<MemberValue>4</MemberValue>
7676
<Docs>
77-
<summary>The enumeration value is 4. Operations are processed after all other non-idle operations are completed.</summary>
77+
<summary>The enumeration value is 4. Operations are processed after all other non-idle operations are completed.</summary>
7878
</Docs>
7979
</Member>
8080
<Member MemberName="ContextIdle">
@@ -95,7 +95,7 @@
9595
</ReturnValue>
9696
<MemberValue>3</MemberValue>
9797
<Docs>
98-
<summary>The enumeration value is 3. Operations are processed after background operations have completed.</summary>
98+
<summary>The enumeration value is 3. Operations are processed after background operations have completed.</summary>
9999
</Docs>
100100
</Member>
101101
<Member MemberName="DataBind">
@@ -116,7 +116,7 @@
116116
</ReturnValue>
117117
<MemberValue>8</MemberValue>
118118
<Docs>
119-
<summary>The enumeration value is 8. Operations are processed at the same priority as data binding.</summary>
119+
<summary>The enumeration value is 8. Operations are processed at the same priority as data binding.</summary>
120120
</Docs>
121121
</Member>
122122
<Member MemberName="Inactive">
@@ -137,7 +137,7 @@
137137
</ReturnValue>
138138
<MemberValue>0</MemberValue>
139139
<Docs>
140-
<summary>The enumeration value is 0. Operations are not processed.</summary>
140+
<summary>The enumeration value is 0. Operations are not processed.</summary>
141141
</Docs>
142142
</Member>
143143
<Member MemberName="Input">
@@ -158,7 +158,7 @@
158158
</ReturnValue>
159159
<MemberValue>5</MemberValue>
160160
<Docs>
161-
<summary>The enumeration value is 5. Operations are processed at the same priority as input.</summary>
161+
<summary>The enumeration value is 5. Operations are processed at the same priority as input.</summary>
162162
</Docs>
163163
</Member>
164164
<Member MemberName="Invalid">
@@ -179,7 +179,7 @@
179179
</ReturnValue>
180180
<MemberValue>-1</MemberValue>
181181
<Docs>
182-
<summary>The enumeration value is -1. This is an invalid priority.</summary>
182+
<summary>The enumeration value is -1. This is an invalid priority.</summary>
183183
</Docs>
184184
</Member>
185185
<Member MemberName="Loaded">
@@ -200,7 +200,7 @@
200200
</ReturnValue>
201201
<MemberValue>6</MemberValue>
202202
<Docs>
203-
<summary>The enumeration value is 6. Operations are processed when layout and render has finished but just before items at input priority are serviced. Specifically this is used when raising the Loaded event.</summary>
203+
<summary>The enumeration value is 6. Operations are processed when layout and render has finished but just before items at input priority are serviced. Specifically this is used when raising the Loaded event.</summary>
204204
</Docs>
205205
</Member>
206206
<Member MemberName="Normal">
@@ -221,7 +221,7 @@
221221
</ReturnValue>
222222
<MemberValue>9</MemberValue>
223223
<Docs>
224-
<summary>The enumeration value is 9. Operations are processed at normal priority. This is the typical application priority.</summary>
224+
<summary>The enumeration value is 9. Operations are processed at normal priority. This is the typical application priority.</summary>
225225
</Docs>
226226
</Member>
227227
<Member MemberName="Render">
@@ -242,7 +242,7 @@
242242
</ReturnValue>
243243
<MemberValue>7</MemberValue>
244244
<Docs>
245-
<summary>The enumeration value is 7. Operations processed at the same priority as rendering.</summary>
245+
<summary>The enumeration value is 7. Operations processed at the same priority as rendering.</summary>
246246
</Docs>
247247
</Member>
248248
<Member MemberName="Send">
@@ -263,7 +263,7 @@
263263
</ReturnValue>
264264
<MemberValue>10</MemberValue>
265265
<Docs>
266-
<summary>The enumeration value is 10. Operations are processed before other asynchronous operations. This is the highest priority.</summary>
266+
<summary>The enumeration value is 10. Operations are processed before other asynchronous operations. This is the highest priority.</summary>
267267
</Docs>
268268
</Member>
269269
<Member MemberName="SystemIdle">
@@ -284,7 +284,7 @@
284284
</ReturnValue>
285285
<MemberValue>1</MemberValue>
286286
<Docs>
287-
<summary>The enumeration value is 1. Operations are processed when the system is idle.</summary>
287+
<summary>The enumeration value is 1. Operations are processed when the system is idle.</summary>
288288
</Docs>
289289
</Member>
290290
</Members>

xml/System.Windows/FrameworkPropertyMetadataOptions.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@
2424
<format type="text/markdown"><![CDATA[
2525
2626
## Remarks
27-
Use this enumeration when you construct a <xref:System.Windows.FrameworkPropertyMetadata> instance where you want to specify one or more the framework-level metadata option settings.
27+
Use this enumeration when you construct a <xref:System.Windows.FrameworkPropertyMetadata> instance, and you want to specify one or more the framework-level metadata option settings.
2828
29-
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 <xref:System.Windows.FrameworkPropertyMetadata>. These property names match the <xref:System.Windows.FrameworkPropertyMetadataOptions> enumeration values except for NotDataBindable, which is <xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A> on the finished <xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A>.
29+
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 <xref:System.Windows.FrameworkPropertyMetadata>. These property names match the `FrameworkPropertyMetadataOptions` enumeration values except for NotDataBindable, which is <xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A> on the finished <xref:System.Windows.FrameworkPropertyMetadata>.
3030
31-
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 [!INCLUDE[TLA2#tla_winclient](~/includes/tla2sharptla-winclient-md.md)] viewer application. In particular, journaling has some known limitations if the element tree was constructed through code rather than [!INCLUDE[TLA2#tla_xaml](~/includes/tla2sharptla-xaml-md.md)]. For details, see [Navigation Overview](~/docs/framework/wpf/app-development/navigation-overview.md).
31+
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](~/docs/framework/wpf/app-development/navigation-overview.md).
3232
3333
> [!NOTE]
34-
> 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 <xref:System.Windows.DependencyProperty.RegisterAttached%2A> to register properties where you specify <xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A> in the metadata.
34+
> 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 <xref:System.Windows.DependencyProperty.RegisterAttached%2A?displayProperty=nameWithType> method to register properties where you specify <xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A?displayProperty=nameWithType> in the metadata.
3535
3636
3737
3838
## Examples
39-
The following example calls the <xref:System.Windows.FrameworkPropertyMetadata> constructor, and sets several options by using values from the <xref:System.Windows.FrameworkPropertyMetadataOptions> enumeration.
39+
The following example calls the <xref:System.Windows.FrameworkPropertyMetadata> constructor and sets several options by using values from the `FrameworkPropertyMetadataOptions` enumeration:
4040
4141
[!code-csharp[PropertyMetadataAPIs#FPMCtor_DV_FPMO_PCC_CVC](~/samples/snippets/csharp/VS_Snippets_Wpf/PropertyMetadataAPIs/CSharp/Class1.cs#fpmctor_dv_fpmo_pcc_cvc)]
4242
@@ -209,7 +209,7 @@
209209
</ReturnValue>
210210
<MemberValue>1024</MemberValue>
211211
<Docs>
212-
<summary>The values of this dependency property should be saved or restored by journaling processes, or when navigating by [!INCLUDE[TLA#tla_uri#initcap#plural](~/includes/tlasharptla-urisharpinitcapsharpplural-md.md)].</summary>
212+
<summary>The values of this dependency property should be saved or restored by journaling processes, or when navigating by Uniform resource identifiers (URIs).</summary>
213213
</Docs>
214214
</Member>
215215
<Member MemberName="None">
@@ -230,7 +230,7 @@
230230
</ReturnValue>
231231
<MemberValue>0</MemberValue>
232232
<Docs>
233-
<summary>No options are specified; the dependency property uses the default behavior of the [!INCLUDE[TLA#tla_winclient](~/includes/tlasharptla-winclient-md.md)] property system.</summary>
233+
<summary>No options are specified; the dependency property uses the default behavior of the WPF property system.</summary>
234234
</Docs>
235235
</Member>
236236
<Member MemberName="NotDataBindable">

0 commit comments

Comments
 (0)