Skip to content

Commit cb6e483

Browse files
yishengjin1413mairaw
yishengjin1413
authored and
mairaw
committed
migrate some API content added by latest mdoc version (#2281)
1 parent bac390e commit cb6e483

File tree

6 files changed

+179
-19
lines changed

6 files changed

+179
-19
lines changed

‎xml/System.Windows.Controls.Primitives/Selector.xml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,24 @@
294294
<AssemblyVersion>4.0.0.0</AssemblyVersion>
295295
</AssemblyInfo>
296296
<Docs>
297-
<summary>To be added.</summary>
298-
<remarks>To be added.</remarks>
297+
<summary>Gets a value that indicates whether the keyboard focus is within the value returned by a <see cref="T:System.Windows.Controls.Primitives.Selector" />.</summary>
298+
<remarks>
299+
<format type="text/markdown"><![CDATA[
300+
301+
## Remarks
302+
303+
This is a rare case of a read-only attached property. You cannot set it in XAML; it exists so that you can check its value on selected items in code.
304+
305+
<a name="dependencyPropertyInfo_IsSelectionActive"></a>
306+
## Dependency Property Information
307+
308+
|||
309+
|-|-|
310+
|Identifier field|<xref:System.Windows.Controls.Primitives.Selector.IsSelectionActiveProperty>|
311+
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A>|
312+
313+
]]></format>
314+
</remarks>
299315
</Docs>
300316
</Member>
301317
<Member MemberName="IsSelectionActiveProperty">

‎xml/System.Windows.Controls.Ribbon/RibbonControlService.xml

Lines changed: 65 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,8 +1198,22 @@
11981198
<AssemblyVersion>4.0.0.0</AssemblyVersion>
11991199
</AssemblyInfo>
12001200
<Docs>
1201-
<summary>To be added.</summary>
1202-
<remarks>To be added.</remarks>
1201+
<summary>Gets a value that indicates whether the control is hosted in a <see cref="T:System.Windows.Controls.Ribbon.RibbonControlGroup" />.</summary>
1202+
<remarks>
1203+
<format type="text/markdown"><![CDATA[
1204+
1205+
## Remarks
1206+
1207+
<a name="dependencyPropertyInfo_IsInControlGroup"></a>
1208+
## Dependency Property Information
1209+
1210+
|||
1211+
|-|-|
1212+
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.IsInControlGroupProperty>|
1213+
|Metadata properties set to `true`|None|
1214+
1215+
]]></format>
1216+
</remarks>
12031217
</Docs>
12041218
</Member>
12051219
<Member MemberName="IsInControlGroupProperty">
@@ -1234,8 +1248,22 @@
12341248
<AssemblyVersion>4.0.0.0</AssemblyVersion>
12351249
</AssemblyInfo>
12361250
<Docs>
1237-
<summary>To be added.</summary>
1238-
<remarks>To be added.</remarks>
1251+
<summary>Gets a value that indicates whether the control is hosted in the Quick Access Toolbar.</summary>
1252+
<remarks>
1253+
<format type="text/markdown"><![CDATA[
1254+
1255+
## Remarks
1256+
1257+
<a name="dependencyPropertyInfo_IsInQuickAccessToolBar"></a>
1258+
## Dependency Property Information
1259+
1260+
|||
1261+
|-|-|
1262+
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.IsInQuickAccessToolBarProperty>|
1263+
|Metadata properties set to `true`|None|
1264+
1265+
]]></format>
1266+
</remarks>
12391267
</Docs>
12401268
</Member>
12411269
<Member MemberName="IsInQuickAccessToolBarProperty">
@@ -1700,8 +1728,23 @@
17001728
<AssemblyVersion>4.0.0.0</AssemblyVersion>
17011729
</AssemblyInfo>
17021730
<Docs>
1703-
<summary>To be added.</summary>
1704-
<remarks>To be added.</remarks>
1731+
<summary>Gets a reference to the <see cref="T:System.Windows.Controls.Ribbon.Ribbon" /> that this control belongs to.</summary>
1732+
<remarks>
1733+
<format type="text/markdown"><![CDATA[
1734+
1735+
## Remarks
1736+
This property is set on the parent <xref:System.Windows.Controls.Ribbon.Ribbon> control and is inherited by the child controls. It is used to access visual style brushes defined on the <xref:System.Windows.Controls.Ribbon.Ribbon> class.
1737+
1738+
<a name="dependencyPropertyInfo_Ribbon"></a>
1739+
## Dependency Property Information
1740+
1741+
|||
1742+
|-|-|
1743+
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.RibbonProperty>|
1744+
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A>|
1745+
1746+
]]></format>
1747+
</remarks>
17051748
</Docs>
17061749
</Member>
17071750
<Member MemberName="RibbonProperty">
@@ -2357,8 +2400,22 @@
23572400
<AssemblyVersion>4.0.0.0</AssemblyVersion>
23582401
</AssemblyInfo>
23592402
<Docs>
2360-
<summary>To be added.</summary>
2361-
<remarks>To be added.</remarks>
2403+
<summary>Gets a value that indicates whether to show the keyboard focus visual for this control.</summary>
2404+
<remarks>
2405+
<format type="text/markdown"><![CDATA[
2406+
2407+
## Remarks
2408+
2409+
<a name="dependencyPropertyInfo_ShowKeyboardCues"></a>
2410+
## Dependency Property Information
2411+
2412+
|||
2413+
|-|-|
2414+
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.ShowKeyboardCuesProperty>|
2415+
|Metadata properties set to `true`|None|
2416+
2417+
]]></format>
2418+
</remarks>
23622419
</Docs>
23632420
</Member>
23642421
<Member MemberName="ShowKeyboardCuesProperty">

‎xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,8 +380,23 @@
380380
<AssemblyVersion>4.0.0.0</AssemblyVersion>
381381
</AssemblyInfo>
382382
<Docs>
383-
<summary>To be added.</summary>
384-
<remarks>To be added.</remarks>
383+
<summary>Gets a value that indicates whether an item in the Quick Access Toolbar is shown in the overflow menu.</summary>
384+
<remarks>
385+
<format type="text/markdown"><![CDATA[
386+
## Remarks
387+
This property can be attached to items in the Quick Access Toolbar.
388+
389+
<a name="dependencyPropertyInfo_IsOverflowItem"></a>
390+
## Dependency Property Information
391+
392+
|||
393+
|-|-|
394+
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonQuickAccessToolBar.IsOverflowItemProperty>|
395+
|Metadata properties set to `true`|None|
396+
397+
]]></format>
398+
</remarks>
399+
<altmember cref="M:System.Windows.Controls.Ribbon.RibbonQuickAccessToolBar.GetIsOverflowItem(System.Windows.DependencyObject)" />
385400
</Docs>
386401
</Member>
387402
<Member MemberName="IsOverflowItemProperty">

‎xml/System.Windows.Controls/Validation.xml

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,44 @@
169169
<AssemblyVersion>4.0.0.0</AssemblyVersion>
170170
</AssemblyInfo>
171171
<Docs>
172-
<summary>To be added.</summary>
173-
<remarks>To be added.</remarks>
172+
<summary>Gets the collection of all active <see cref="T:System.Windows.Controls.ValidationError" /> objects on the bound element.</summary>
173+
<remarks>
174+
<format type="text/markdown"><![CDATA[
175+
## Remarks
176+
The application cannot modify the content of this collection. See the Example section for an example of how to use this attached property.
177+
178+
The WPF data binding model enables you to associate <xref:System.Windows.Data.Binding.ValidationRules%2A> with your <xref:System.Windows.Data.Binding> object. Validation occurs during binding target-to-binding source value transfer before the converter is called. The following describes the validation process:
179+
180+
1. When a value is being transferred from the target property to the source property, the data binding engine first removes any <xref:System.Windows.Controls.ValidationError> that may have been added to the <xref:System.Windows.Controls.Validation.Errors%2A?displayProperty=fullName> attached property of the bound element. It then checks if there are any custom <xref:System.Windows.Controls.ValidationRule>s defined for that <xref:System.Windows.Data.Binding>, in which case it calls the <xref:System.Windows.Controls.ValidationRule.Validate%2A> method on each of the <xref:System.Windows.Controls.ValidationRule>s until one of them runs into an error or until all of them pass.
181+
182+
2. Once there is a custom rule that does not pass, the binding engine creates a <xref:System.Windows.Controls.ValidationError> object and adds it to the <xref:System.Windows.Controls.Validation.Errors%2A?displayProperty=fullName> collection of the bound element. When <xref:System.Windows.Controls.Validation.Errors%2A?displayProperty=fullName> is not empty, the <xref:System.Windows.Controls.Validation.HasError%2A?displayProperty=fullName> attached property of the element is set to `true`. Also, if the <xref:System.Windows.Data.Binding.NotifyOnValidationError%2A> property of the <xref:System.Windows.Data.Binding> is set to `true`, then the binding engine raises the <xref:System.Windows.Controls.Validation.Error?displayProperty=fullName> attached event on the element.
183+
184+
3. If all of the rules pass, the binding engine then calls the converter, if one exists.
185+
186+
4. If the converter passes, the binding engine calls the setter of the source property.
187+
188+
5. If the binding has an <xref:System.Windows.Controls.ExceptionValidationRule> associated with it and an exception is thrown during step 4, the binding engine checks to see if there is a <xref:System.Windows.Data.Binding.UpdateSourceExceptionFilter%2A>. You have the option to use the <xref:System.Windows.Data.Binding.UpdateSourceExceptionFilter%2A> callback to provide a custom handler for handling exceptions. If an <xref:System.Windows.Data.Binding.UpdateSourceExceptionFilter%2A> is not specified on the <xref:System.Windows.Data.Binding>, the binding engine creates a <xref:System.Windows.Controls.ValidationError> with the exception and adds it to the <xref:System.Windows.Controls.Validation.Errors%2A?displayProperty=fullName> collection of the bound element.
189+
190+
Also note that a valid value transfer in either direction (target-to-source or source-to-target) clears the <xref:System.Windows.Controls.Validation>.<xref:System.Windows.Controls.Validation.Errors%2A>attached property.
191+
192+
For information about the behavior of this property in <xref:System.Windows.Data.MultiBinding> scenarios, see <xref:System.Windows.Data.MultiBindingExpression.ValidationError%2A>.
193+
194+
For more information, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview).
195+
196+
<a name="xamlTextUsage_Errors"></a>
197+
## XAML Text Usage
198+
See Remarks. The <xref:System.Windows.Controls.Validation.Errors%2A> collection itself is not user settable, but you can use it in a control template definition in XAML.
199+
200+
<a name="dependencyPropertyInfo_Errors"></a>
201+
## Dependency Property Information
202+
203+
|||
204+
|-|-|
205+
|Identifier field|<xref:System.Windows.Controls.Validation.ErrorsProperty>|
206+
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A>|
207+
208+
]]></format>
209+
</remarks>
174210
</Docs>
175211
</Member>
176212
<Member MemberName="ErrorsProperty">
@@ -411,8 +447,27 @@
411447
<AssemblyVersion>4.0.0.0</AssemblyVersion>
412448
</AssemblyInfo>
413449
<Docs>
414-
<summary>To be added.</summary>
415-
<remarks>To be added.</remarks>
450+
<summary>Gets a value that indicates whether any binding on the binding target element has a <see cref="T:System.Windows.Controls.ValidationError" />.</summary>
451+
<remarks>
452+
<format type="text/markdown"><![CDATA[
453+
454+
## Remarks
455+
For information about the behavior of this property in <xref:System.Windows.Data.MultiBinding> scenarios, see <xref:System.Windows.Data.MultiBindingExpression.HasError%2A>.
456+
457+
For a detailed discussion of validation, see the Data Validation section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview).
458+
459+
<a name="dependencyPropertyInfo_HasError"></a>
460+
## Dependency Property Information
461+
462+
|||
463+
|-|-|
464+
|Identifier field|<xref:System.Windows.Controls.Validation.HasErrorProperty>|
465+
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A>|
466+
467+
]]></format>
468+
</remarks>
469+
<altmember cref="P:System.Windows.Data.Binding.ValidationRules" />
470+
<altmember cref="P:System.Windows.Data.MultiBinding.ValidationRules" />
416471
</Docs>
417472
</Member>
418473
<Member MemberName="HasErrorProperty">

‎xml/System.Windows.Navigation/BaseUriHelper.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<AssemblyVersion>4.0.0.0</AssemblyVersion>
3333
</AssemblyInfo>
3434
<Docs>
35-
<summary>To be added.</summary>
35+
<summary>Gets or sets the base uniform resource identifier (URI).</summary>
3636
<remarks>To be added.</remarks>
3737
</Docs>
3838
</Member>

‎xml/System.Windows/VisualStateManager.xml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -462,8 +462,25 @@
462462
<AssemblyVersion>4.0.0.0</AssemblyVersion>
463463
</AssemblyInfo>
464464
<Docs>
465-
<summary>To be added.</summary>
466-
<remarks>To be added.</remarks>
465+
<summary>Gets or sets a collection of <see cref="T:System.Windows.VisualStateGroup" /> objects.</summary>
466+
<remarks>
467+
<format type="text/markdown"><![CDATA[
468+
469+
## Remarks
470+
Each <xref:System.Windows.VisualStateGroup> contains a collection of <xref:System.Windows.VisualState> objects. A <xref:System.Windows.VisualState> contains a collection of <xref:System.Windows.Media.Animation.Storyboard> objects that specify how the control's appearance changes when the control is in a certain state. For example, a <xref:System.Windows.Controls.Button> might have a slightly different appearance when it is pressed than when it is not pressed. Two states that the <xref:System.Windows.Controls.Button> defines correspond to when it is pressed (`"Pressed"`) and when it is not (`"Normal"`).
471+
472+
You add <xref:System.Windows.VisualState> to a control by setting the <xref:System.Windows.VisualStateManager.VisualStateGroups%2A> attached property on the control. You put states that are mutually exclusive to each other in the same <xref:System.Windows.VisualStateGroup>. For example, the <xref:System.Windows.Controls.CheckBox> has two <xref:System.Windows.VisualStateGroup> objects. One contains the states, `Normal`, `MouseOver`, `Pressed`, and `Disabled`. The other contains the states, `Checked`, `UnChecked`, and `Indeterminate`. The <xref:System.Windows.Controls.CheckBox> can be in states `MouseOver` and `UnChecked` at the same time, but it cannot be in the `MouseOver` and `Pressed` states at the same time.
473+
474+
Although you can add <xref:System.Windows.VisualState> objects to any element, they are a particularly useful way to enable others to redefine the visual behavior of a <xref:System.Windows.Controls.Control>. If you create a custom control that uses a <xref:System.Windows.Controls.ControlTemplate>, you can specify which states that control can be in by adding a <xref:System.Windows.TemplateVisualStateAttribute> on its class definition. Then anyone who creates a new <xref:System.Windows.Controls.ControlTemplate> for your control can add <xref:System.Windows.VisualState> objects to the template. States with the same <xref:System.Windows.TemplateVisualStateAttribute.GroupName%2A?displayProperty=fullName> belong in the same <xref:System.Windows.VisualStateGroup>.
475+
476+
For more information about how to use <xref:System.Windows.VisualStateGroup> objects in a <xref:System.Windows.Controls.ControlTemplate>, see [Customizing the Appearance of an Existing Control by Creating a ControlTemplate](/dotnet/framework/wpf/controls/customizing-the-appearance-of-an-existing-control). For more information about how to create controls that use the <xref:System.Windows.VisualStateManager>, see [Creating a Control That Has a Customizable Appearance](/dotnet/framework/wpf/controls/creating-a-control-that-has-a-customizable-appearance).
477+
478+
## Examples
479+
The following example creates a simple <xref:System.Windows.Controls.ControlTemplate> for a <xref:System.Windows.Controls.Button> that contains one <xref:System.Windows.Controls.Grid>. It also contains a <xref:System.Windows.VisualStateGroup> named `CommonStates`, which defines the `MouseOver` and `Normal` states. The <xref:System.Windows.VisualStateGroup> also has a <xref:System.Windows.VisualTransition> that specifies that it takes one half second for the <xref:System.Windows.Controls.Grid> to change from green to red when the user moves the mouse pointer over the <xref:System.Windows.Controls.Button>.
480+
481+
[!code-xaml[VSMButtonTemplate#11](~/samples/snippets/csharp/VS_Snippets_Wpf/vsmbuttontemplate/csharp/window1.xaml#11)]
482+
]]></format>
483+
</remarks>
467484
</Docs>
468485
</Member>
469486
<Member MemberName="VisualStateGroupsProperty">

0 commit comments

Comments
 (0)