Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
250 lines (229 sloc) 19.7 KB
<Type Name="RangeValuePattern+RangeValuePatternInformation" FullName="System.Windows.Automation.RangeValuePattern+RangeValuePatternInformation">
<TypeSignature Language="C#" Value="public struct RangeValuePattern.RangeValuePatternInformation" />
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit RangeValuePattern/RangeValuePatternInformation extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation" />
<TypeSignature Language="VB.NET" Value="Public Structure RangeValuePattern.RangeValuePatternInformation" />
<TypeSignature Language="C++ CLI" Value="public: value class RangeValuePattern::RangeValuePatternInformation" />
<TypeSignature Language="F#" Value="type RangeValuePattern.RangeValuePatternInformation = struct" />
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides access to the property values of a <see cref="T:System.Windows.Automation.RangeValuePattern" /> object using its <see cref="P:System.Windows.Automation.TransformPattern.Current" /> or <see cref="P:System.Windows.Automation.TransformPattern.Cached" /> accessors.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Automation.Provider.IRangeValueProvider" />
<related type="Article" href="~/docs/framework/ui-automation/ui-automation-control-patterns-overview.md">UI Automation Control Patterns Overview</related>
<related type="Article" href="~/docs/framework/ui-automation/ui-automation-control-patterns-for-clients.md">UI Automation Control Patterns for Clients</related>
<related type="Article" href="https://msdn.microsoft.com/library/ec722dff-6009-4279-b86a-e18d3fa94ebf">Use Caching in UI Automation</related>
</Docs>
<Members>
<Member MemberName="IsReadOnly">
<MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsReadOnly" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.IsReadOnly" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsReadOnly As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsReadOnly { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsReadOnly : bool" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.IsReadOnly" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies whether the value of a [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element is read-only.</summary>
<value>
<see langword="true" /> if the value is read-only; <see langword="false" /> if it can be modified. The default is <see langword="true" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A control should have its <xref:System.Windows.Automation.AutomationElement.IsEnabledProperty> set to `true` and its <xref:System.Windows.Automation.ValuePattern.IsReadOnlyProperty> set to `false` prior to the creation of a <xref:System.Windows.Automation.RangeValuePattern> object.
## Examples
In the following example, an <xref:System.Windows.Automation.AutomationElement> that supports the <xref:System.Windows.Automation.RangeValuePattern> control pattern has its value incremented or decremented by the control-specific <xref:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange%2A> value.
[!code-csharp[UIARangeValuePattern_snip#103LargeChange](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103largechange)]
[!code-vb[UIARangeValuePattern_snip#103LargeChange](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103largechange)]
[!code-csharp[UIARangeValuePattern_snip#103](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103)]
[!code-vb[UIARangeValuePattern_snip#103](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103)]
[!code-csharp[UIARangeValuePattern_snip#101](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#101)]
[!code-vb[UIARangeValuePattern_snip#101](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#101)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="LargeChange">
<MemberSignature Language="C#" Value="public double LargeChange { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 LargeChange" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LargeChange As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double LargeChange { double get(); };" />
<MemberSignature Language="F#" Value="member this.LargeChange : double" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the control-specific large-change value which is added to or subtracted from the <see cref="P:System.Windows.Automation.Provider.IRangeValueProvider.Value" /> property.</summary>
<value>The large-change value or <see langword="null" /> if the element does not support <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange" />. The default value is 0.0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, an <xref:System.Windows.Automation.AutomationElement> that supports the <xref:System.Windows.Automation.RangeValuePattern> control pattern has its value incremented or decremented by the control-specific <xref:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange%2A> value.
[!code-csharp[UIARangeValuePattern_snip#103LargeChange](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103largechange)]
[!code-vb[UIARangeValuePattern_snip#103LargeChange](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103largechange)]
[!code-csharp[UIARangeValuePattern_snip#103](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103)]
[!code-vb[UIARangeValuePattern_snip#103](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103)]
[!code-csharp[UIARangeValuePattern_snip#101](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#101)]
[!code-vb[UIARangeValuePattern_snip#101](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#101)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.SmallChange" />
</Docs>
</Member>
<Member MemberName="Maximum">
<MemberSignature Language="C#" Value="public double Maximum { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Maximum" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Maximum" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Maximum As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double Maximum { double get(); };" />
<MemberSignature Language="F#" Value="member this.Maximum : double" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Maximum" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum range value supported by the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element.</summary>
<value>The maximum value supported by the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element or <see langword="null" /> if the element does not support <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Maximum" />. The default value is 0.0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, an <xref:System.Windows.Automation.AutomationElement> that supports the <xref:System.Windows.Automation.RangeValuePattern> control pattern has its value set to the control-specific maximum value.
[!code-csharp[UIARangeValuePattern_snip#104Maximum](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#104maximum)]
[!code-vb[UIARangeValuePattern_snip#104Maximum](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#104maximum)]
[!code-csharp[UIARangeValuePattern_snip#104](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#104)]
[!code-vb[UIARangeValuePattern_snip#104](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#104)]
[!code-csharp[UIARangeValuePattern_snip#101](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#101)]
[!code-vb[UIARangeValuePattern_snip#101](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#101)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Minimum" />
</Docs>
</Member>
<Member MemberName="Minimum">
<MemberSignature Language="C#" Value="public double Minimum { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Minimum" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Minimum" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Minimum As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double Minimum { double get(); };" />
<MemberSignature Language="F#" Value="member this.Minimum : double" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Minimum" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the minimum range value supported by the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element.</summary>
<value>The minimum value supported by the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element or <see langword="null" /> if the element does not support <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Minimum" />. The default value is 0.0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, an <xref:System.Windows.Automation.AutomationElement> that supports the <xref:System.Windows.Automation.RangeValuePattern> control pattern has its value set to the control-specific minimum value.
[!code-csharp[UIARangeValuePattern_snip#104Minimum](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#104minimum)]
[!code-vb[UIARangeValuePattern_snip#104Minimum](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#104minimum)]
[!code-csharp[UIARangeValuePattern_snip#104](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#104)]
[!code-vb[UIARangeValuePattern_snip#104](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#104)]
[!code-csharp[UIARangeValuePattern_snip#101](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#101)]
[!code-vb[UIARangeValuePattern_snip#101](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#101)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Maximum" />
</Docs>
</Member>
<Member MemberName="SmallChange">
<MemberSignature Language="C#" Value="public double SmallChange { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 SmallChange" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.SmallChange" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SmallChange As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double SmallChange { double get(); };" />
<MemberSignature Language="F#" Value="member this.SmallChange : double" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.SmallChange" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the small-change value, unique to the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element, which is added to or subtracted from the elements <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Value" /> property.</summary>
<value>The small-change value unique to the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element or <see langword="null" /> if the element does not support <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.SmallChange" />. The default value is 0.0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, an <xref:System.Windows.Automation.AutomationElement> that supports the <xref:System.Windows.Automation.RangeValuePattern> control pattern has its value incremented or decremented by the control-specific <xref:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.SmallChange%2A> value.
[!code-csharp[UIARangeValuePattern_snip#103SmallChange](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103smallchange)]
[!code-vb[UIARangeValuePattern_snip#103SmallChange](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103smallchange)]
[!code-csharp[UIARangeValuePattern_snip#103](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#103)]
[!code-vb[UIARangeValuePattern_snip#103](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#103)]
[!code-csharp[UIARangeValuePattern_snip#101](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#101)]
[!code-vb[UIARangeValuePattern_snip#101](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#101)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.LargeChange" />
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public double Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Value" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double Value { double get(); };" />
<MemberSignature Language="F#" Value="member this.Value : double" Usage="System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current value of the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element.</summary>
<value>The current value of the [!INCLUDE[TLA2#tla_uiautomation](~/includes/tla2sharptla-uiautomation-md.md)] element or <see langword="null" /> if the element does not support <see cref="P:System.Windows.Automation.RangeValuePattern.RangeValuePatternInformation.Value" />. The default value is 0.0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, a <xref:System.Windows.Automation.RangeValuePattern> object obtained from a target control is passed into a function that retrieves the current <xref:System.Windows.Automation.RangeValuePattern> property values.
[!code-csharp[UIARangeValuePattern_snip#102](~/samples/snippets/csharp/VS_Snippets_Wpf/UIARangeValuePattern_snip/CSharp/UIARangeValuePattern_snippets.cs#102)]
[!code-vb[UIARangeValuePattern_snip#102](~/samples/snippets/visualbasic/VS_Snippets_Wpf/UIARangeValuePattern_snip/VisualBasic/UIARangeValuePattern_snippets.vb#102)]
]]></format>
</remarks>
<altmember cref="M:System.Windows.Automation.RangeValuePattern.SetValue(System.Double)" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.