The GwxDynamic type exposes the following members.

Methods

  NameDescription
Public methodCheckAccess
Determines whether the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Protected methodCloneCore (Inherited from FreezableFilteredCustomTypeDescriptorBase.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Protected methodCloneCurrentValueCore (Inherited from FreezableFilteredCustomTypeDescriptorBase.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Protected methodGetAsFrozenCore (Inherited from FreezableFilteredCustomTypeDescriptorBase.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Protected methodGetCurrentValueAsFrozenCore (Inherited from FreezableFilteredCustomTypeDescriptorBase.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetHighLimitValue
During runtime, gets the current value of the high limit used by this dynamic animation.
Public methodGetLastWrittenValue
Gets the last data value that was written via this dynamic, or null if no data value has been written.
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLowLimitValue
During runtime, gets the current value of the low limit used by this dynamic animation.
Public methodGetParentDocument
Gets the document to which this dynamic object belongs.
Public methodGetParentDynamicGroup
Gets the group of dynamic objects (attached to a target object) to which this dynamic object belongs.
Public methodGetParentElement
Gets the parent DependencyObject with which this dynamic is associated In other words, this method returns the visual object that is animated by this dynamic.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodGetValueOfPrimaryDataSource
During runtime, gets the current value of the data provided by the DataSource property.
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRefreshPrimaryDataSource
During runtime, for the data value of the DataSource property, invokes asynchronous reading on the data server so that the client application gets a new update
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Protected methodShouldSerializeProperty (Inherited from FreezableFilteredCustomTypeDescriptorBase.)
Public methodToString
Gets a string representation of the type of this dynamic.
(Overrides Object..::..ToString()()()().)
Public methodVerifyAccess
Enforces that the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Public methodWriteValueToPrimaryDataSource
During runtime, writes the specified value to the data value of the DataSource property.
Public methodWriteValueToPrimaryDataSourceNoConfirm
During runtime, writes the specified value to the data value of the DataSource property. This method will not prompt the user to confirm the written value even if the dynamic is configured to do so.

Fields

  NameDescription
Public fieldStatic memberAccelerationRatioProperty
DependencyProperty for the AccelerationRatio property.
Public fieldStatic memberAnimateWhenTrueProperty
DependencyProperty for the AnimateWhenTrue property.
Public fieldStatic memberAnimationModeProperty
DependencyProperty for the AnimationMode property.
Public fieldStatic memberAutoReverseProperty
DependencyProperty for the AutoReverse property.
Public fieldStatic memberCommentProperty
DependencyProperty for the Comment property.
Public fieldStatic memberCommentRequiredProperty
DependencyProperty for the CommentRequired property.
Public fieldStatic memberConfirmProperty
DependencyProperty for the Confirm property.
Public fieldStatic memberContinuousWriteProperty
DependencyProperty for the ContinuousWrite property.
Public fieldStatic memberControlProperty
DependencyProperty for the Control property.
Public fieldStatic memberCustomDataProperty
DependencyProperty for the CustomData property.
Public fieldStatic memberDataComparisonProperty
DependencyProperty for the DataComparison property.
Public fieldStatic memberDataSourceProperty
DependencyProperty for the DataSource property.
Public fieldStatic memberDecelerationRatioProperty
DependencyProperty for the DecelerationRatio property.
Public fieldStatic memberDescriptionProperty
DependencyProperty for the Description property.
Public fieldStatic memberDragDropDataSourceProperty
DependencyProperty for the DragDropDataSource property.
Public fieldStatic memberDurationProperty
DependencyProperty for the Duration property.
Public fieldStatic memberDynamicStateWhenToggleOffProperty
DependencyProperty for the DynamicStateWhenToggleOff property.
Public fieldStatic memberEnableControlEventsProperty
DependencyProperty for the EnableControlEvents property.
Public fieldStatic memberEndPercentProperty
DependencyProperty for the EndPercent property.
Public fieldStatic memberFillBehaviorProperty
DependencyProperty for the FillBehavior property.
Public fieldStatic memberFreezeWhenNotAnimatingProperty
DependencyProperty for the FreezeWhenNotAnimating property.
Public fieldStatic memberHighLimitSourceProperty
DependencyProperty for the HighLimitSource property.
Public fieldStatic memberInitialValueProperty
DependencyProperty for the InitialValue property.
Public fieldStatic memberLowLimitSourceProperty
DependencyProperty for the LowLimitSource property.
Public fieldStatic memberNameProperty
DependencyProperty for the Name property.
Public fieldStatic memberPartitionModeProperty
DependencyProperty for the PartitionMode property.
Public fieldStatic memberPartitionOriginProperty
DependencyProperty for the PartitionOrigin property.
Public fieldStatic memberPartitionValueProperty
DependencyProperty for the PartitionValue property.
Public fieldStatic memberPeriodicToggleRateProperty
DependencyProperty for the PeriodicToggleRate property.
Public fieldStatic memberRepeatCountProperty
DependencyProperty for the RepeatCount property.
Public fieldStatic memberResolveAliasesInDragDropDataSourceProperty
DependencyProperty for the ResolveAliasesInDragDropDataSource property.
Public fieldStatic memberReverseAnimateWhenFalseProperty
DependencyProperty for the ReverseAnimateWhenFalse property.
Public fieldStatic memberSafeTouchProperty
DependencyProperty for the SafeTouch property.
Public fieldStatic memberShowDataSourceNameInToolTipProperty
DependencyProperty for the ShowDataSourceNameInToolTip property.
Public fieldStatic memberShowDataSourceValueInToolTipProperty
DependencyProperty for the ShowDataSourceValueInToolTip property.
Public fieldStatic memberShowDescriptionInToolTipProperty
DependencyProperty for the ShowDescriptionInToolTip property.
Public fieldStatic memberShowErrorInformationInToolTipProperty
DependencyProperty for the ShowErrorInformationInToolTip property.
Public fieldStatic memberShowToolTipProperty
DependencyProperty for the ShowToolTip property.
Public fieldStatic memberSkipInitialDurationProperty
DependencyProperty for the SkipInitialDuration property.
Public fieldStatic memberStartDelayProperty
DependencyProperty for the StartDelay property.
Public fieldStatic memberStartPercentProperty
DependencyProperty for the StartPercent property.
Public fieldStatic memberUpdateProperty
DependencyProperty for the Update property.
Public fieldStatic memberWriteInitialValueProperty
DependencyProperty for the WriteInitialValue property.

Properties

  NameDescription
Public propertyAccelerationRatio
The percentage of the animation's Duration spent accelerating the passage of time from zero to its maximum rate (range: 0.0 to 1.0).
Public propertyAnimateWhenTrue
Causes the animation to be active when the datasource comparison yields a result of "true" (after applying reverse compare logic if specified).
Public propertyAnimationMode
Indicates the animation behavior of this dynamic.
Public propertyAutoReverse
Causes the animation to automatically play in reverse after its forward iteration has finished.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyComment
When this property is true, if Confirm is also true, this property indicates that the confirmation message will provide the user with field to enter a comment to be logged for the written value. This property is unused when the Confirm property is false.
Public propertyCommentRequired
When this property is true, if Confirm and Comment are also true, this property indicates that the user must enter a non-empty comment to be logged for the written value. This property is unused when either the Confirm or Comment properties are false.
Public propertyConfirm
When true, this property indicates that a warning message should be displayed prior to performing a data write that has been initiated via user interaction (the warning message allows the user to cancel the pending data write, or to proceed with the write). When false, the data write occurs without a confirmation message. This property is unused when the dynamic is not controllable.
Public propertyContinuousWrite
When true, this property indicates that the dynamic should continuously write new values while the user is interacting with the dynamic control (as in the case of dragging a slider). When false, this property indicates that the dynamic should only write a value when the user has finished interacting with the dynamic control (as in the case of releasing a slider after having dragged it to a new position).
Public propertyControl
When this property is true, this target object associated with this dynamic can be clicked on by the user to perform some action (i.e. slider, dial, button, dataentry). Usually, controllable objects are used to write data values.
Public propertyCustomConfirmMessage
A custom confirmation message.
Public propertyCustomData
A string field for custom data. The purpose of this field is defined by the user; it can be used to hold any extra configuration data in string format.
Public propertyDataComparison
Type of comparison for DataSource and Limit(s) (or zero).

For Discrete Animations - animation will activate when comparison is true.

For Analog Animation - animation will be skipped when comparison is false (if not specified, animation is always active).

For GwxProcessPoint - designates type of range validation for data entry.

Public propertyDataSource
The primary data connection for this dynamic object. Datasources can be an OPC tag, expression, constant value, or local variable.
Public propertyDecelerationRatio
The percentage of the animation's Duration spent decelerating the passage of time from zero to its maximum rate (range: 0.0 to 1.0).
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDescription
A user defined description string for this dynamic.
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyDragDropDataSource
Indicates that the DataSource of this dynamic can be drag/dropped during runtime into another component such as the Trend viewer.
Public propertyDuration
In general this property represents the time it takes for an animation to complete a cycle. This time is expressed in milliseconds.
Public propertyDynamicConnectionList
This list is used internally to compose a list of multiple dynamics to a single more complex/powerful dynamic object. A prime example of this is the GwxPickMenuItem dynamic configured to display a popup menu. In this case, the DynamicConnectionList is used to create a tree of child GwxPick objects, each representing a different command item on the menu. Other dynamics that use this list are GwxStateSelector, GwxRangeSelector, and GwxProcessPoint.
Public propertyDynamicStateWhenToggleOff
This property indicates that when this dynamic is not toggling, the alternate state of the dynamic (rather than the default state) should be used. For instance, if toggle (flash) is specified for a GwxHide dynamic, when this property is true, the associated static object will be hidden when not flashing (when this property is false, the object will be visible when not flashing).
Public propertyEnableControlEvents
True to enable execution of commmands when events occur.
Public propertyEnabled
When this property is false, the control behavior for this dynamic is disabled.
Public propertyEndPercent
Used to specify an ending magnitude for the animation (range: 0.0 to 1.0).
Public propertyFillBehavior
When the value is FillBehavior.Stop, this property indicates that the animated object returns to its default state when the animation's duration (including repeats) has expired. When the value is FillBehavior.HoldEnd, this property indicates that the animated object stays in its current state when the animation's duration has expired.

The default value is FillBehavior.HoldEnd. This property has no effect if the repeat count is infinite, or if there is no Duration.

Public propertyFreezeWhenNotAnimating
When false, this property indicates that the animated object returns to its default state when the animation is stopped. When true, this property indicates that the animated object stays in its current state when an animation is stopped.
Public propertyHighLimitSource
This property specifies a high limit for value used in the analog animation.
Public propertyInitialValue
Initial value to be written.
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLowLimitSource
This property specifies a low limit for value used in the analog animation.
Public propertyName
For internal use only. Not for customer use.

A unique user-friendly name that can be used to identify the object.

Public propertyPartitionMode
Indicates how to define the "partition" behavior of this analog dynamic. This feature is used to divide an analog range into a specified number of steps (useful for providing "tick" behavior in sliders, for example).
Public propertyPartitionOrigin
This property specifies the starting analog value from which subsequent steps are calculated. This value is only used when partitionmode="DeltaValue".
Public propertyPartitionValue
When partitionmode="NumberOfPartitions" this property specifies the number of steps to subdivide the analog value’s range into.

When partitionmode="DeltaValue" this property specifies an increment/decrement value between each step within the range.

Public propertyPeriodicToggleRate
If this property is specified, when the discrete state of the primary datasource would activate this dynamic, rather then simply activate the dynamic, the dynamic’s activation state will be periodically toggled on and off. This property represents the time interval between toggle state changes (i.e. for GwxHide and GwxColor dynamics, this represents the flash rate). This time is expressed in milliseconds.
Public propertyRepeatCount
This property causes a discrete state animation to run/repeat the specified number of times. If this value is less than zero, the animation repeats infinitely.
Public propertyResolveAliasesInDragDropDataSource
True to resolve global aliases in the DataSource before dropping the DataSource on another component. False to leave the global aliases unresolved (to be resolved by the component that receives the dropped DataSource). Default to use the document-level setting for ResolveAliasesInDragDropDataSources.
Public propertyReverseAnimateWhenFalse
Causes the animation to be active (in the reverse direction) when the datasource comparison yields a result of "false" (after applying reverse compare logic if specified).
Public propertySafeTouch
When true, this property indicates that the user must be touching a "safe zone" in order to use this control in runtime mode. This property only applies to "Touch" interaction - mouse and keyboard interactions are not affected by this property.
Public propertyShowDataSourceNameInToolTip
Determines whether or not to include the DataSource Name for this dynamic in tooltips.
Public propertyShowDataSourceValueInToolTip
Determines whether or not to include the DataSource Value for this dynamic in tooltips.
Public propertyShowDescriptionInToolTip
Determines whether or not to include the Description for this dynamic in tooltips.
Public propertyShowErrorInformationInToolTip
Determines whether or not to include the error information for this dynamic in tooltips.
Public propertyShowToolTip
Determines whether or not to include information for this dynamic in tooltips.
Public propertySkipInitialDuration
Indicates that the duration of a time-based dynamic will be skipped for the first data update.

This is useful, for example, for a time-based Hide dynamic that uses both AnimateWhenTrue and ReverseAnimateWhenFalse, to prevent an initial fade-out.

Public propertyStartDelay
This property represents a delay time before an activated animation will begin. This time is expressed in milliseconds.
Public propertyStartPercent
Used to specify a starting magnitude for the animation (range: 0.0 to 1.0).
Public propertyUpdate
When true, this property indicates that the dynamic updates whenever the value of the associated DataSource changes. When false, this property indicates that the dynamic updates only when new values are written. Useful for sliders, dials, and data-entries.
Public propertyUseCustomConfirmMessage
True to specify a custom confirmation message.
Public propertyWriteInitialValue
Indicates that this dynamic will write an initial value after its datasource has been requested.

Events

  NameDescription
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventDataUpdated
Occurs when this dynamic has been updated for a data change.

See Also