Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
273 lines (240 sloc) 20.3 KB
<Type Name="StringAnimationBase" FullName="System.Windows.Media.Animation.StringAnimationBase">
<TypeSignature Language="C#" Value="public abstract class StringAnimationBase : System.Windows.Media.Animation.AnimationTimeline" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit StringAnimationBase extends System.Windows.Media.Animation.AnimationTimeline" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.StringAnimationBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class StringAnimationBase&#xA;Inherits AnimationTimeline" />
<TypeSignature Language="C++ CLI" Value="public ref class StringAnimationBase abstract : System::Windows::Media::Animation::AnimationTimeline" />
<TypeSignature Language="F#" Value="type StringAnimationBase = class&#xA; inherit AnimationTimeline" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.Animation.AnimationTimeline</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Abstract class that, when implemented, animates a <see cref="T:System.String" /> value.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to use the derived <xref:System.Windows.Media.Animation.StringAnimationUsingKeyFrames> class in [!INCLUDE[TLA#tla_xaml](~/includes/tlasharptla-xaml-md.md)].
[!code-xaml[keyframes_ovw_snippet#StringAnimationUsingKeyFramesWholePage](~/samples/snippets/csharp/VS_Snippets_Wpf/keyframes_ovw_snippet/CS/StringAnimationUsingKeyFramesExample.xaml#stringanimationusingkeyframeswholepage)]
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>See the [Custom Animations Overview](~/docs/framework/wpf/graphics-multimedia/custom-animations-overview.md) for information about extending animation classes.</para>
</block>
<altmember cref="T:System.Windows.Media.Animation.StringAnimationUsingKeyFrames" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected StringAnimationBase ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StringAnimationBase.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; StringAnimationBase();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.StringAnimationBase" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public System.Windows.Media.Animation.StringAnimationBase Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Animation.StringAnimationBase Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StringAnimationBase.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As StringAnimationBase" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Windows::Media::Animation::StringAnimationBase ^ Clone();" />
<MemberSignature Language="F#" Value="override this.Clone : unit -&gt; System.Windows.Media.Animation.StringAnimationBase" Usage="stringAnimationBase.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Animation.StringAnimationBase</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Animation.StringAnimationBase" />, 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.</summary>
<returns>A modifiable clone of the current object. The cloned object's <see cref="P:System.Windows.Freezable.IsFrozen" /> property will be <see langword="false" /> even if the source's <see cref="P:System.Windows.Freezable.IsFrozen" /> property was <see langword="true." /></returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects (or any <xref:System.Windows.Freezable> object). For convenience, this method shadows the inherited version with a strongly typed implementation.
For more information, see <xref:System.Windows.Freezable.Clone%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetCurrentValue">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Gets the current value of the animation.</summary>
</Docs>
</MemberGroup>
<Member MemberName="GetCurrentValue">
<MemberSignature Language="C#" Value="public override sealed object GetCurrentValue (object defaultOriginValue, object defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object GetCurrentValue(object defaultOriginValue, object defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StringAnimationBase.GetCurrentValue(System.Object,System.Object,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::Object ^ GetCurrentValue(System::Object ^ defaultOriginValue, System::Object ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberSignature Language="F#" Value="override this.GetCurrentValue : obj * obj * System.Windows.Media.Animation.AnimationClock -&gt; obj" Usage="stringAnimationBase.GetCurrentValue (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.Object" />
<Parameter Name="defaultDestinationValue" Type="System.Object" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The origin value provided to the animation if the animation does not have its own start value.</param>
<param name="defaultDestinationValue">The destination value provided to the animation if the animation does not have its own destination value.</param>
<param name="animationClock">The <see cref="T:System.Windows.Media.Animation.AnimationClock" /> which can generate the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> value to be used by the animation to generate its output value.</param>
<summary>Gets the current value of the animation.</summary>
<returns>The current value of the animation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the `defaultOriginValue` parameter depends on the animation's position in the composition chain:
- If the animation is in the first position in a composition chain and it replaces another animation, `defaultOriginValue` is the output of that animation at the time it was replaced.
- 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 <xref:System.Windows.Media.Animation.AnimationClock> that is not <xref:System.Windows.Media.Animation.Clock.Stopped%2A>.
The value of the `defaultDestinationValue` parameter depends on whether there is a previous property <xref:System.Windows.Trigger> composition layer.
- If there is a previous property <xref:System.Windows.Trigger> composition layer, `defaultDestinationValue` is the output from that layer.
- If there is no previous composition layer, `defaultDestinationValue` is the base value of the property that you are animating.
For more information about animation composition, see the [Animation and Timing System Overview](~/docs/framework/wpf/graphics-multimedia/animation-and-timing-system-overview.md). For more information about creating custom animation types, see the [Custom Animations Overview](~/docs/framework/wpf/graphics-multimedia/custom-animations-overview.md).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValue">
<MemberSignature Language="C#" Value="public string GetCurrentValue (string defaultOriginValue, string defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetCurrentValue(string defaultOriginValue, string defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StringAnimationBase.GetCurrentValue(System.String,System.String,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetCurrentValue(System::String ^ defaultOriginValue, System::String ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberSignature Language="F#" Value="override this.GetCurrentValue : string * string * System.Windows.Media.Animation.AnimationClock -&gt; string" Usage="stringAnimationBase.GetCurrentValue (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.String" />
<Parameter Name="defaultDestinationValue" Type="System.String" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The origin value provided to the animation if the animation does not have its own start value.</param>
<param name="defaultDestinationValue">The destination value provided to the animation if the animation does not have its own destination value.</param>
<param name="animationClock">The <see cref="T:System.Windows.Media.Animation.AnimationClock" /> which can generate the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> value to be used by the animation to generate its output value.</param>
<summary>Gets the current value of the animation.</summary>
<returns>The current value of this animation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the `defaultOriginValue` parameter depends on the animation's position in the composition chain:
- If the animation is in the first position in a composition chain and it replaces another animation, `defaultOriginValue` is the output of that animation at the time it was replaced.
- 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 <xref:System.Windows.Media.Animation.AnimationClock> that is not <xref:System.Windows.Media.Animation.Clock.Stopped%2A>.
The value of the `defaultDestinationValue` parameter depends on whether there is a previous property <xref:System.Windows.Trigger> composition layer.
- If there is a previous property <xref:System.Windows.Trigger> composition layer, `defaultDestinationValue` is the output from that layer.
- If there is no previous composition layer, `defaultDestinationValue` is the base value of the property that you are animating.
For more information about animation composition, see the [Animation and Timing System Overview](~/docs/framework/wpf/graphics-multimedia/animation-and-timing-system-overview.md). For more information about creating custom animation types, see the [Custom Animations Overview](~/docs/framework/wpf/graphics-multimedia/custom-animations-overview.md).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValueCore">
<MemberSignature Language="C#" Value="protected abstract string GetCurrentValueCore (string defaultOriginValue, string defaultDestinationValue, System.Windows.Media.Animation.AnimationClock animationClock);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetCurrentValueCore(string defaultOriginValue, string defaultDestinationValue, class System.Windows.Media.Animation.AnimationClock animationClock) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.StringAnimationBase.GetCurrentValueCore(System.String,System.String,System.Windows.Media.Animation.AnimationClock)" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; abstract System::String ^ GetCurrentValueCore(System::String ^ defaultOriginValue, System::String ^ defaultDestinationValue, System::Windows::Media::Animation::AnimationClock ^ animationClock);" />
<MemberSignature Language="F#" Value="abstract member GetCurrentValueCore : string * string * System.Windows.Media.Animation.AnimationClock -&gt; string" Usage="stringAnimationBase.GetCurrentValueCore (defaultOriginValue, defaultDestinationValue, animationClock)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="defaultOriginValue" Type="System.String" />
<Parameter Name="defaultDestinationValue" Type="System.String" />
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">The suggested origin value, used if the animation does not have its own explicitly set start value.</param>
<param name="defaultDestinationValue">The suggested destination value, used if the animation does not have its own explicitly set end value.</param>
<param name="animationClock">An <see cref="T:System.Windows.Media.Animation.AnimationClock" /> that generates the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> used by the host animation.</param>
<summary>Calculates a value that represents the current value of the property being animated, as determined by the host animation.</summary>
<returns>The calculated value of the property, as determined by the current animation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the `defaultOriginValue` parameter depends on the animation's position in the composition chain:
- If the animation is in the first position in a composition chain and it replaces another animation, `defaultOriginValue` is the output of that animation at the time it was replaced.
- 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 <xref:System.Windows.Media.Animation.AnimationClock> that is not <xref:System.Windows.Media.Animation.Clock.Stopped%2A>.
The value of the `defaultDestinationValue` parameter depends on whether there is a previous property <xref:System.Windows.Trigger> composition layer.
- If there is a previous property <xref:System.Windows.Trigger> composition layer, `defaultDestinationValue` is the output from that layer.
- If there is no previous composition layer, `defaultDestinationValue` is the base value of the property that you are animating.
For more information about animation composition, see the [Animation and Timing System Overview](~/docs/framework/wpf/graphics-multimedia/animation-and-timing-system-overview.md). For more information about creating custom animation types, see the [Custom Animations Overview](~/docs/framework/wpf/graphics-multimedia/custom-animations-overview.md).
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.AnimationClock" />
</Docs>
</Member>
<Member MemberName="TargetPropertyType">
<MemberSignature Language="C#" Value="public override sealed Type TargetPropertyType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TargetPropertyType" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Animation.StringAnimationBase.TargetPropertyType" />
<MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable ReadOnly Property TargetPropertyType As Type" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property Type ^ TargetPropertyType { Type ^ get(); };" />
<MemberSignature Language="F#" Value="member this.TargetPropertyType : Type" Usage="System.Windows.Media.Animation.StringAnimationBase.TargetPropertyType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the type of value this animation generates.</summary>
<value>The type of value produced by this animation.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.