Skip to content

migrate some API content added by latest mdoc version #2281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2019
Merged

migrate some API content added by latest mdoc version #2281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions xml/System.Windows.Controls.Primitives/Selector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,24 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

<a name="dependencyPropertyInfo_IsSelectionActive"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Primitives.Selector.IsSelectionActiveProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A>|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsSelectionActiveProperty">
Expand Down
73 changes: 65 additions & 8 deletions xml/System.Windows.Controls.Ribbon/RibbonControlService.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1198,8 +1198,22 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the control is hosted in a <see cref="T:System.Windows.Controls.Ribbon.RibbonControlGroup" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<a name="dependencyPropertyInfo_IsInControlGroup"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.IsInControlGroupProperty>|
|Metadata properties set to `true`|None|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsInControlGroupProperty">
Expand Down Expand Up @@ -1234,8 +1248,22 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether the control is hosted in the Quick Access Toolbar.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<a name="dependencyPropertyInfo_IsInQuickAccessToolBar"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.IsInQuickAccessToolBarProperty>|
|Metadata properties set to `true`|None|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsInQuickAccessToolBarProperty">
Expand Down Expand Up @@ -1700,8 +1728,23 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a reference to the <see cref="T:System.Windows.Controls.Ribbon.Ribbon" /> that this control belongs to.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

<a name="dependencyPropertyInfo_Ribbon"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.RibbonProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.Inherits%2A>|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RibbonProperty">
Expand Down Expand Up @@ -2357,8 +2400,22 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether to show the keyboard focus visual for this control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<a name="dependencyPropertyInfo_ShowKeyboardCues"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonControlService.ShowKeyboardCuesProperty>|
|Metadata properties set to `true`|None|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ShowKeyboardCuesProperty">
Expand Down
19 changes: 17 additions & 2 deletions xml/System.Windows.Controls.Ribbon/RibbonQuickAccessToolBar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,8 +380,23 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether an item in the Quick Access Toolbar is shown in the overflow menu.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property can be attached to items in the Quick Access Toolbar.

<a name="dependencyPropertyInfo_IsOverflowItem"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Ribbon.RibbonQuickAccessToolBar.IsOverflowItemProperty>|
|Metadata properties set to `true`|None|

]]></format>
</remarks>
<altmember cref="M:System.Windows.Controls.Ribbon.RibbonQuickAccessToolBar.GetIsOverflowItem(System.Windows.DependencyObject)" />
</Docs>
</Member>
<Member MemberName="IsOverflowItemProperty">
Expand Down
63 changes: 59 additions & 4 deletions xml/System.Windows.Controls/Validation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,44 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets the collection of all active <see cref="T:System.Windows.Controls.ValidationError" /> objects on the bound element.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## 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 <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:

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.

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.

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 <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.

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.

For information about the behavior of this property in <xref:System.Windows.Data.MultiBinding> scenarios, see <xref:System.Windows.Data.MultiBindingExpression.ValidationError%2A>.

For more information, see "Data Validation" in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview).

<a name="xamlTextUsage_Errors"></a>
## XAML Text Usage
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.

<a name="dependencyPropertyInfo_Errors"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Validation.ErrorsProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A>|

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ErrorsProperty">
Expand Down Expand Up @@ -411,8 +447,27 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets a value that indicates whether any binding on the binding target element has a <see cref="T:System.Windows.Controls.ValidationError" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
For information about the behavior of this property in <xref:System.Windows.Data.MultiBinding> scenarios, see <xref:System.Windows.Data.MultiBindingExpression.HasError%2A>.

For a detailed discussion of validation, see the Data Validation section of the [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview).

<a name="dependencyPropertyInfo_HasError"></a>
## Dependency Property Information

|||
|-|-|
|Identifier field|<xref:System.Windows.Controls.Validation.HasErrorProperty>|
|Metadata properties set to `true`|<xref:System.Windows.FrameworkPropertyMetadata.IsNotDataBindable%2A>|

]]></format>
</remarks>
<altmember cref="P:System.Windows.Data.Binding.ValidationRules" />
<altmember cref="P:System.Windows.Data.MultiBinding.ValidationRules" />
</Docs>
</Member>
<Member MemberName="HasErrorProperty">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Windows.Navigation/BaseUriHelper.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the base uniform resource identifier (URI).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
21 changes: 19 additions & 2 deletions xml/System.Windows/VisualStateManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,8 +462,25 @@
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Gets or sets a collection of <see cref="T:System.Windows.VisualStateGroup" /> objects.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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"`).

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.

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>.

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).

## Examples
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>.

[!code-xaml[VSMButtonTemplate#11](~/samples/snippets/csharp/VS_Snippets_Wpf/vsmbuttontemplate/csharp/window1.xaml#11)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="VisualStateGroupsProperty">
Expand Down