The GwxDynamic type exposes the following members.
Methods
Name | Description | |
---|---|---|
CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) | |
ClearValue(DependencyProperty) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) | |
ClearValue(DependencyPropertyKey) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) | |
Clone | 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.) | |
CloneCore | (Inherited from FreezableFilteredCustomTypeDescriptorBase.) | |
CloneCurrentValue | Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.) | |
CloneCurrentValueCore | (Inherited from FreezableFilteredCustomTypeDescriptorBase.) | |
CoerceValue | 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.) | |
Equals | Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.) | |
Freeze | Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.) | |
GetAsFrozen | 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.) | |
GetAsFrozenCore | (Inherited from FreezableFilteredCustomTypeDescriptorBase.) | |
GetCurrentValueAsFrozen | 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.) | |
GetCurrentValueAsFrozenCore | (Inherited from FreezableFilteredCustomTypeDescriptorBase.) | |
GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) | |
GetHighLimitValue |
During runtime, gets the current value of the high limit used by this dynamic animation.
| |
GetLastWrittenValue |
Gets the last data value that was written via this dynamic, or null if no data value has been written.
| |
GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) | |
GetLowLimitValue |
During runtime, gets the current value of the low limit used by this dynamic animation.
| |
GetParentDocument |
Gets the document to which this dynamic object belongs.
| |
GetParentDynamicGroup |
Gets the group of dynamic objects (attached to a target object)
to which this dynamic object belongs.
| |
GetParentElement |
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.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) | |
GetValueOfPrimaryDataSource |
During runtime, gets the current value of the data provided by the DataSource property.
| |
InvalidateProperty | Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.) | |
ReadLocalValue | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) | |
RefreshPrimaryDataSource |
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
| |
SetCurrentValue | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) | |
SetValue(DependencyProperty, Object) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) | |
SetValue(DependencyPropertyKey, Object) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) | |
ShouldSerializeProperty | (Inherited from FreezableFilteredCustomTypeDescriptorBase.) | |
ToString |
Gets a string representation of the type of this dynamic.
(Overrides Object..::..ToString()()()().) | |
VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) | |
WriteValueToPrimaryDataSource |
During runtime, writes the specified value to the data value of the DataSource property.
| |
WriteValueToPrimaryDataSourceNoConfirm |
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
Properties
Name | Description | |
---|---|---|
AccelerationRatio |
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).
| |
AnimateWhenTrue |
Causes the animation to be active when the datasource
comparison yields a result of "true" (after applying reverse
compare logic if specified).
| |
AnimationMode |
Indicates the animation behavior of this dynamic.
| |
AutoReverse |
Causes the animation to automatically play in reverse after its forward iteration has finished.
| |
CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) | |
Comment |
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.
| |
CommentRequired | ||
Confirm |
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.
| |
ContinuousWrite |
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).
| |
Control |
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.
| |
CustomConfirmMessage |
A custom confirmation message.
| |
CustomData |
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.
| |
DataComparison |
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.
| |
DataSource |
The primary data connection for this dynamic object.
Datasources can be an OPC tag, expression, constant value,
or local variable.
| |
DecelerationRatio |
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).
| |
DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) | |
Description |
A user defined description string for this dynamic.
| |
Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) | |
DragDropDataSource |
Indicates that the DataSource of this dynamic can be drag/dropped during runtime into
another component such as the Trend viewer.
| |
Duration |
In general this property represents the time it takes for an
animation to complete a cycle. This time is expressed in
milliseconds.
| |
DynamicConnectionList |
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.
| |
DynamicStateWhenToggleOff |
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).
| |
EnableControlEvents |
True to enable execution of commmands when events occur.
| |
Enabled |
When this property is false, the control behavior for this dynamic is disabled.
| |
EndPercent |
Used to specify an ending magnitude for the animation (range: 0.0 to 1.0).
| |
FillBehavior |
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.
| |
FreezeWhenNotAnimating |
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.
| |
HighLimitSource |
This property specifies a high limit for value used in the
analog animation.
| |
InitialValue |
Initial value to be written.
| |
IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) | |
IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) | |
LowLimitSource |
This property specifies a low limit for value used in the
analog animation.
| |
Name |
For internal use only. Not for customer use.
A unique user-friendly name that can be used to identify the object.
| |
PartitionMode |
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).
| |
PartitionOrigin |
This property specifies the starting analog value from which
subsequent steps are calculated. This value is only used when
partitionmode="DeltaValue".
| |
PartitionValue |
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.
| |
PeriodicToggleRate |
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.
| |
RepeatCount |
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.
| |
ResolveAliasesInDragDropDataSource |
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.
| |
ReverseAnimateWhenFalse |
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).
| |
SafeTouch |
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.
| |
ShowDataSourceNameInToolTip |
Determines whether or not to include the DataSource Name for this dynamic in tooltips.
| |
ShowDataSourceValueInToolTip |
Determines whether or not to include the DataSource Value for this dynamic in tooltips.
| |
ShowDescriptionInToolTip |
Determines whether or not to include the Description for this dynamic in tooltips.
| |
ShowErrorInformationInToolTip |
Determines whether or not to include the error information for this dynamic in tooltips.
| |
ShowToolTip |
Determines whether or not to include information for this dynamic in tooltips.
| |
SkipInitialDuration |
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.
| |
StartDelay |
This property represents a delay time before an activated
animation will begin. This time is expressed in
milliseconds.
| |
StartPercent |
Used to specify a starting magnitude for the animation (range: 0.0 to 1.0).
| |
Update |
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.
| |
UseCustomConfirmMessage |
True to specify a custom confirmation message.
| |
WriteInitialValue |
Indicates that this dynamic will write an initial value
after its datasource has been requested.
|
Events
Name | Description | |
---|---|---|
Changed | Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.) | |
DataUpdated |
Occurs when this dynamic has been updated for a data change.
|