From c0a55911ac66caff70dfbefb83a3dcb69c991025 Mon Sep 17 00:00:00 2001 From: Mike Norman Date: Fri, 16 Jun 2017 14:14:27 -0500 Subject: Parameter complete drive and change to Trigger.xml (#992) * Parameter complete drive and change to Trigger.xml * update docs --- .../Xamarin.Forms.Core/Xamarin.Forms/Animation.xml | 56 ++++++------ .../Xamarin.Forms/AnimationExtensions.xml | 100 ++++++++++----------- .../Xamarin.Forms/AppLinkEntry.xml | 2 +- .../Xamarin.Forms/Application.xml | 8 +- docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml | 12 +-- .../Xamarin.Forms/Behavior`1.xml | 8 +- docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml | 3 +- docs/Xamarin.Forms.Core/index.xml | 90 +++++++++---------- 8 files changed, 140 insertions(+), 139 deletions(-) (limited to 'docs/Xamarin.Forms.Core') diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml index 06f28675..0172988b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Animation.xml @@ -64,11 +64,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + An action that is called with successive animation values. + The fraction into the current animation at which to start the animation. + The fraction into the current animation at which to end the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. Creates a new object with the specified parameters. To be added. @@ -95,9 +95,9 @@ - To be added. - To be added. - To be added. + The fraction into this animation at which the added child animation will begin animating. + The fraction into this animation at which the added child animation will stop animating. + The animation to add. Adds an object to this that begins at and finishes at . To be added. @@ -128,13 +128,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The owning animation that will be animated. + The name, or handle, that is used to access and track the animation and its state. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Runs the animation with the supplied parameters. To be added. @@ -207,9 +207,9 @@ - To be added. - To be added. - To be added. + The fraction into this animation at which the added child animation will begin animating. + The fraction into this animation at which the added child animation will stop animating. + The animation to add. Adds an object to this that begins at and finishes at . To be added. To be added. @@ -237,9 +237,9 @@ - To be added. - To be added. - To be added. + The animation to add. + The fraction into this animation at which the added child animation will begin animating. + The fraction into this animation at which the added child animation will stop animating. Adds to the children of this object and sets the start and end times of to and , respectively. To be added. To be added. @@ -270,13 +270,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - Creates a new object with the specified parameters, and adds it to the children of this object. + An action that is called with successive animation values. + The fraction into the current animation at which to start the animation. + The fraction into the current animation at which to end the animation. + The easing function to use to transision in, out, or in and out of the animation. + The fraction into this animation at which the added child animation will begin animating. + The fraction into this animation at which the added child animation will stop animating. + Creates a new object with the specified , and adds it to the children of this object. To be added. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml index 211f5e31..bbdd8563 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AnimationExtensions.xml @@ -16,7 +16,7 @@ - Extension methods for . + Extension methods for objects. To be added. @@ -41,8 +41,8 @@ - To be added. - To be added. + The object on which this method will be run. + An animation key that must be unique among its sibling and parent animations for the duration of the animation. Stops the animation. To be added. If refers to an animation that belongs to this instance, then its tweener handlers are removed, the tweener is stopped, the animation is removed from this instance, and it is marked as finished. If refers to one of the kinetics that belong to this instance, then it and its ticker are removed. @@ -75,14 +75,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. To be added. @@ -114,14 +114,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + The animation to run. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. To be added. @@ -155,16 +155,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The fraction into the current animation at which to start the animation. + The fraction into the current animation at which to stop the animation. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. To be added. @@ -201,15 +201,15 @@ To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + A function that maps animation times to new time values. + An action that is called with successive animation values. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. To be added. @@ -239,12 +239,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The amount that the animation progresses in each animation step. For example, a velocity of 1 progresses at the default speed. + The amount that the progression speed is reduced per frame. Can be negative. + An action to call when the animation is finished. Sets the specified parameters and starts the kinetic animation. To be added. @@ -270,8 +270,8 @@ - To be added. - To be added. + The object on which this method will be run. + An animation key that must be unique among its sibling and parent animations for the duration of the animation. Returns a Boolean value that indicates whether or not the animation that is specified by is running. To be added. To be added. @@ -300,10 +300,10 @@ - To be added. - To be added. - To be added. - To be added. + The fraction into the current animation at which to start the animation. + The fraction into the current animation at which to stop the animation. + The inverse scale factor to use if is . + Whether to use the inverse scale factor in to deinterpolate. Returns a function that performs a linear interpolation between and . A function that performs a linear interpolation between and . Application developers can pass values between 0.0f and 1.0f to this function in order to recieve a value that is offset from or , depending on the value of , by the passed value times the distance between and . If is , then the interpolation happens between and . diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml index 3d816067..306f9fa4 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/AppLinkEntry.xml @@ -112,7 +112,7 @@ - To be added. + A URI that can be parsed by the target appliction to recreate a specific state. Creates and returns a new for the specified . To be added. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml index 0bb70fa3..c63cdb50 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Application.xml @@ -119,7 +119,7 @@ - To be added. + For internal use by the Xamarin.Forms platform. For internal use by the Xamarin.Forms platform. To be added. To be added. @@ -471,7 +471,7 @@ - To be added. + For internal use by the Xamarin.Forms platform. For internal use by the Xamarin.Forms platform. To be added. @@ -559,7 +559,7 @@ - To be added. + For internal use by the Xamarin.Forms platform. For internal use by the Xamarin.Forms platform. To be added. @@ -583,7 +583,7 @@ - To be added. + For internal use by the Xamarin.Forms platform. For internal use by the Xamarin.Forms platform. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml index 123f2d0e..eb7a4309 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior.xml @@ -56,7 +56,7 @@ - To be added. + The bindable object to which the behavior was attached. Application developers override this method to implement the behaviors that will be associated with . To be added. @@ -78,7 +78,7 @@ - To be added. + The bindable object from which the behavior was detached. Application developers override this method to remove the behaviors from that were implemented in a previous call to the method. To be added. @@ -100,8 +100,8 @@ - To be added. - Attempts to attach to . If successful, calls the method. + For internal use by the Xamarin.Forms platform. + AFor internal use by the Xamarin.Forms platform. To be added. @@ -122,8 +122,8 @@ - To be added. - Detaches from . Calls the method. + For internal use by the Xamarin.Forms platform. + For internal use by the Xamarin.Forms platform. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml index e5a32feb..7e0a8b37 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Behavior`1.xml @@ -62,7 +62,7 @@ - To be added. + The bindable object to which the behavior was attached. Application developers override this method to implement the behaviors that will be associated with . To be added. @@ -84,7 +84,7 @@ - To be added. + The bindable object to which the behavior was attached. Attaches to the superclass and then calls the method on this object. To be added. @@ -106,7 +106,7 @@ - To be added. + The bindable object from which the behavior was detached. Application developers override this method to remove the behaviors from that were implemented in a previous call to the method. To be added. @@ -128,7 +128,7 @@ - To be added. + The bindable object from which the behavior was detached. Calls the method and then detaches from the superclass. To be added. diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml index 1be2ca38..d6a7600b 100644 --- a/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Trigger.xml @@ -31,6 +31,7 @@ The XML example below prompts the user to type in the secret, which is, "The text color is red". When the user has typed the secret, the Entry text changes color to red. The code is turned back to the default color if the user then edits the text to differ from the secret. This example shows how to bind to the enclosing control with a trigger. - + diff --git a/docs/Xamarin.Forms.Core/index.xml b/docs/Xamarin.Forms.Core/index.xml index e4341819..9f14fe7b 100644 --- a/docs/Xamarin.Forms.Core/index.xml +++ b/docs/Xamarin.Forms.Core/index.xml @@ -564,8 +564,8 @@ - To be added. - To be added. + The object on which this method will be run. + An animation key that must be unique among its sibling and parent animations for the duration of the animation. Stops the animation. @@ -595,16 +595,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The fraction into the current animation at which to start the animation. + The fraction into the current animation at which to stop the animation. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. @@ -632,14 +632,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. @@ -667,14 +667,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + The animation to run. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. @@ -707,15 +707,15 @@ To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + A function that maps animation times to new time values. + An action that is called with successive animation values. + The time, in milliseconds, between frames. + The number of milliseconds over which to interpolate the animation. + The easing function to use to transision in, out, or in and out of the animation. + An action to call when the animation is finished. + A function that returns true if the animation should continue. Sets the specified parameters and starts the animation. @@ -741,12 +741,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The object on which this method will be run. + An animation key that should be unique among its sibling and parent animations for the duration of the animation. + An action that is called with successive animation values. + The amount that the animation progresses in each animation step. For example, a velocity of 1 progresses at the default speed. + The amount that the progression speed is reduced per frame. Can be negative. + An action to call when the animation is finished. Sets the specified parameters and starts the kinetic animation. @@ -768,8 +768,8 @@ - To be added. - To be added. + The object on which this method will be run. + An animation key that must be unique among its sibling and parent animations for the duration of the animation. Returns a Boolean value that indicates whether or not the animation that is specified by is running. -- cgit v1.2.3