The GwxDocument 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.) | |
CreateDelegate |
Creates a Delegate of the specified type for the specified script function.
| |
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.) | |
GetAliasValue |
Gets the alias value of the local alias item that has the specified alias name (if there is one).
| |
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.) | |
GetDataSources |
Gets a collection of all of the datasources included in the current display.
| |
GetDynamicGroupFromTargetName |
Retrieve a GwxDynamicGroup object given its associated TargetName
| |
GetDynamicGroups |
Gets an array of all GwxDynamicGroup objects in this display.
| |
GetDynamicObjectByName |
Retrieve a GwxDynamic object given its name.
| |
GetElementByName |
Gets the visual object with the specified name.
| |
GetElementByTitle |
Gets the visual object with the specified title.
| |
GetElementsByName |
Gets a list of visual objects with the specified name.
| |
GetElementsByTitle |
Gets a list of visual objects with the specified title.
| |
GetExpressionDataSources |
Gets a list of all "local-expression" datasources used in the current display.
| |
GetFileVersion |
Gets the version of the application that was used to save the currently loaded file.
| |
GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) | |
GetLocalAliases()()()() |
Gets the local aliases currently defined in this display.
| |
GetLocalAliases(String) |
Gets the local aliases defined in the display with the specified filename.
| |
GetLocalAliases(DependencyObject) |
Gets the object-level local aliases currently defined for the specified visual object.
| |
GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) | |
GetSimulationDataSources |
Gets a list of all "local-simulation" datasources used in the current display.
| |
GetSourcePath |
Gets the path of the currently loaded display (minus the file name).
| |
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.) | |
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.) | |
SetAliasValue(String, String) |
Sets the alias value of the local alias item that has the specified alias name (if there is one).
| |
SetAliasValue(String, String, String) |
Sets the alias value of the local alias item that has the specified alias name (if there is one) for
the specified visual object.
| |
SetAliasValue(DependencyObject, String, String) |
Sets the alias value of the local alias item that has the specified alias name (if there is one) for
the specified visual object.
| |
SetAliasValues(AliasCommandType, String) |
Sets local aliases in the display based on the specified command data.
| |
SetAliasValues(String, AliasCommandType, String) |
Sets local aliases for the specified visual object based on the specified command data.
| |
SetCurrentCultureName |
Sets the culture that is used by Language Aliasing.
| |
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 |
Overrides ToString()()()().
(Overrides Object..::..ToString()()()().) | |
VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
Fields
Name | Description | |
---|---|---|
CachePriorityProperty | DependencyProperty for the CachePriority property. | |
DataEntryLostFocusWritesValueProperty | DependencyProperty for the DataEntryLostFocusWritesValue property. | |
DefaultViewProperty | DependencyProperty for the DefaultView()()()() property. | |
DesiredFrameRateProperty | DependencyProperty for the DesiredFrameRate property. | |
DisableControlWhenAnyRelatedDynamicIsDisabledProperty | DependencyProperty for the DisableControlWhenAnyRelatedDynamicIsDisabled property. | |
DisableControlWhenReadOnlyDataProperty | DependencyProperty for the DisableControlWhenReadOnlyData property. | |
DisableControlWhenSecurityDeniedProperty | DependencyProperty for the DisableControlWhenSecurityDenied property. | |
DisabledFillBrushProperty | DependencyProperty for the DisabledFillColor property. | |
DisabledFillColorProperty | DependencyProperty for the DisabledFillColor property. | |
DisabledLineBrushProperty | DependencyProperty for the DisabledLineColor property. | |
DisabledLineColorProperty | DependencyProperty for the DisabledLineColor property. | |
EnableControlEventsProperty | DependencyProperty for the EnableControlEvents property. | |
GlobalAliasesProperty | DependencyProperty for the DEFAULT_GlobalAliases()()()() property. | |
HideDynamicActiveWhenPointFailureExProperty | DependencyProperty for the HideDynamicActiveWhenPointFailureEx property. | |
HorizontallyAlignedAdjustableFaceplateScreenHeightProperty |
Horizontally-aligned adjustable faceplate screen height property for a display.
This property stores the screen height of the adjustable faceplate
when the display orientation is horizontal.
DependencyProperty for the HorizontallyAlignedAdjustableFaceplateScreenHeight()()()() property. | |
HorizontallyAlignedAdjustableFaceplateScreenWidthProperty |
Horizontally-aligned adjustable faceplate screen width property for a display.
This property stores the screen width of the adjustable faceplate
when the display orientation is horizontal.
DependencyProperty for the HorizontallyAlignedAdjustableFaceplateScreenWidth()()()() property. | |
HorizontallyAlignedDisplayHeightProperty |
For internal use only. Not for customer use.
Horizontally-aligned display height property for a display.
This property stores the height of the display as if its
dimensions have never been swapped.
DependencyProperty for the HorizontallyAlignedDisplayWidth()()()() property. | |
HorizontallyAlignedDisplayWidthProperty |
Horizontally-aligned display width property for a display.
This property stores the width of the display as if its
dimensions have never been swapped.
DependencyProperty for the HorizontallyAlignedDisplayWidth()()()() property. | |
IsScalableProperty | DependencyProperty for the IsScalable property. | |
MaximumZoomProperty | DependencyProperty for the MaximumZoom property. | |
MinimumZoomProperty | DependencyProperty for the MinimumZoom property. | |
MobileDisplayFaceplateNameProperty |
Mobile display faceplate name property for a display.
DependencyProperty for the MobileDisplayFaceplateName()()()() property. | |
MobileDisplayFaceplateOrientationProperty |
Mobile display faceplate orientation property for a display.
DependencyProperty for the MobileDisplayFaceplateOrientation()()()() property. | |
MobileDisplayFaceplateVisibleProperty |
Mobile display faceplate visible property for a display.
DependencyProperty for the MobileDisplayFaceplateVisible()()()() property. | |
MobileDisplayStyleProperty | DependencyProperty for the MobileDisplayStyle property. | |
OrientationLockProperty | DependencyProperty for the OrientationLock property. | |
PanEnabledProperty | DependencyProperty for the PanEnabled property. | |
PasswordProperty | DependencyProperty for the DEFAULT_Password()()()() property. | |
PointFailFillBrushProperty | DependencyProperty for the PointFailFillColor property. | |
PointFailFillColorProperty | DependencyProperty for the PointFailFillColor property. | |
PointFailLineBrushProperty | DependencyProperty for the PointFailLineColor property. | |
PointFailLineColorProperty | DependencyProperty for the PointFailLineColor property. | |
PointFailTextProperty | DependencyProperty for the PointFailText property. | |
PreferredStretchProperty | DependencyProperty for the PreferredStretch property. | |
ReleaseOutOfViewDataProperty | DependencyProperty for the ReleaseOutOfViewData property. | |
ResolveAliasesInDragDropDataSourcesProperty | DependencyProperty for the ResolveAliasesInDragDropDataSources property. | |
SafeTouchZoneWarningDurationProperty | DependencyProperty for the SafeTouchZoneWarningDuration property. | |
SavePasswordProperty | DependencyProperty for the DEFAULT_SavePassword()()()() property. | |
ShowControlCursorProperty | DependencyProperty for the ShowControlCursor property. | |
ShowControlFocusProperty | DependencyProperty for the ShowControlFocus property. | |
SwapDimensionsOnOrientationChangeProperty | DependencyProperty for the SwapDimensionsOnOrientationChange property. | |
UseDisabledColorsProperty | DependencyProperty for the UseDisabledColors property. | |
UsePointFailColorsForUncertainQualityProperty | DependencyProperty for the UsePointFailColorsForUncertainQuality property. | |
UsePointFailColorsProperty | DependencyProperty for the UsePointFailColors property. | |
UsePointFailTextForUncertainQualityProperty | DependencyProperty for the UsePointFailTextForUncertainQuality property. | |
UsePointFailTextProperty | DependencyProperty for the UsePointFailText property. | |
ZoomEnabledProperty | DependencyProperty for the ZoomEnabled property. |
Properties
Name | Description | |
---|---|---|
Animated |
True if in runtime mode, false otherwise
| |
CachePriority |
When the available cache space is running low, this option determines which
displays will be removed from the cache first.
| |
CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) | |
CompanyName |
Gets the name of the company or creator of this component.
| |
Configuration |
Gets the instance of GwxConfiguration associated with this document (if available).
| |
CurrentCulture |
Gets the current CultureInfo provided by Language Aliasing.
| |
CustomFonts |
Custom fonts that are available to use in this display.
| |
CustomViews |
Custom views that are used to change the current zoom and pan when selected by the user.
| |
DataEntryLostFocusWritesValue |
When true, clicking outside of an active Data Entry field will write the value (the Escape key can still be used to cancel writing the value).
When false, clicking outside of an active Data Entry field will cancel the write (the Enter key or Tab key must be used to write the value).
The default value is false. Use with caution since setting this to true may increase the likelihood of unintended writes by operators.
| |
DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) | |
DesiredFrameRate |
Specifies the desired frame rate (updates per second) for time-based animations (animations with a Duration). Specify zero to animate as smoothly as possible (using the available processing resources).
This property can be used to reduce the amount of processing resources needed for time-based animations (if the smoothest possible animation rate is not required).
| |
DisableControlWhenAnyRelatedDynamicIsDisabled |
Specify true so that if any dynamic on a given object is disabled, all other dynamics on that object will also be disabled.
Specify false so that each dynamic on a given object can be independently disabled. The default value is false.
| |
DisableControlWhenReadOnlyData |
Disables controllable dynamics that reference readonly DataSources.
| |
DisableControlWhenSecurityDenied |
Disables controllable dynamics when security permission is denied.
| |
DisabledFillBrush |
Alternate color to indicate that an object is disabled.
Currently only supports SolidColorBrush.
| |
DisabledFillColor |
Alternate color to indicate that an object is disabled.
| |
DisabledLineBrush |
Alternate color to indicate that an object is disabled.
Currently only supports SolidColorBrush.
| |
DisabledLineColor |
Alternate color to indicate that an object is disabled.
| |
Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) | |
DisplayTabs |
Tabs used to load display files.
| |
EnableControlEvents |
True to enable execution of commmands when events occur.
| |
FocusBorderOptions |
Options for the "focus border". The focus border appears around user-interactive objects in runtime when the mouse pointer
is over the object, or if the object has keyboard focus.
| |
GlobalAliases |
The global aliases to set when opening the display in runtime.
| |
HideDynamicActiveWhenPointFailureEx |
When True, hide dynamics that are configured to activate when the data value evaluates to false and
currently have a bad quality data value, will be set to the "active" state (i.e. hidden).
When False, hide dynamics that have a bad quality data source will be set to the "inactive" state
(i.e. visible) and drawn with the "PointFailColors".
When Default, hide dynamics will remain in their current visibility state when their data value becomes bad quality
(if currently visible, they will be drawn with the "PointFailColors").
| |
IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) | |
IsScalable |
True to make this display scalable when it is loaded. False for a fixed-scale display.
| |
IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) | |
MaximumZoom |
The maximum allowed zoom.
| |
MinimumZoom |
The minimum allowed zoom.
| |
MobileDisplayStyle |
Whether or not to swap display dimensions when the orientation of the phone is changed
| |
MobileProductName |
Gets the "mobile" product name associated with this component.
| |
OrientationLock |
The orientation lock of the phone
| |
PanEnabled |
True to enable panning/scrolling during runtime, false to disable panning/scrolling during runtime.
| |
Password |
The password required to allow this display to be loaded in configuration mode.
| |
PointFailFillBrush |
Alternate color to indicate that an object has a bad quality data source.
Currently only supports SolidColorBrush.
| |
PointFailFillColor |
Alternate color to indicate that an object has a bad quality data source.
| |
PointFailLineBrush |
Alternate color to indicate that an objec thas a bad quality data source.
Currently only supports SolidColorBrush.
| |
PointFailLineColor |
Alternate color to indicate that an objec thas a bad quality data source.
| |
PointFailText |
Text displayed for process points that have data errors. Specify a single character (repeated for length of PPT), or a multi-character string (not repeated).
| |
PreferredStretch |
The stretch mode to use for scalable displays and "Fit to Window" operations.
| |
ProductName |
Gets the product name associated with this component.
| |
ProductVersion |
Gets the version of this component.
| |
ReleaseOutOfViewData |
Automatically releases runtime data for objects that are not within the currently visible
display area (due to zooming/panning). Data is re-requested when an object re-enters the
visible display area.
| |
ResolveAliasesInDragDropDataSources |
True to resolve global aliases in drag-drop DataSources before dropping the DataSources on another component.
False to leave the global aliases unresolved (to be resolved by the component that receives the dropped DataSources).
| |
RootVisual | Visual that is the visual root for the currently loaded display.
| |
RuntimeWindowProperties |
Window properties for runtime mode.
| |
SafeTouchZoneWarningDuration |
The amount of time (in ms) the safe-touch warning (localsim::safeTouchZoneWarning) will remain active before automatically resetting to inactive.
Note: the safe-touch warning will also immediately reset to inactive if the user touches a safe-zone.
Use -1 to indicate infinite duration. Use 0 (zero) to indicate that the warning should never be activated.
| |
ScanRate |
The default scan rate (in milliseconds) for requested data values.
| |
ShowControlCursor |
True to show alternate mouse cursor when hovering over a controllable dynamic object.
| |
ShowControlFocus |
True to show a highlight indicator around controllable dynamics that have keyboard focus.
| |
Source |
The uri of the current display
| |
SpecifyRuntimeWindowProperties |
True to specify non-default window properties for runtime mode.
| |
StateFieldDropDownUsesSystemColors |
When true, the statefield drop-down UI will use the current "System Colors" (defined by the Operating System).
When false, the statefield drop-down UI will use colors that match Label associated with the ProcessPoint dynamic (this is the default).
| |
StoreConfigurationGridSettings |
True to indicate that the configuration grid settings should be stored in the display file.
| |
SwapDimensionsOnOrientationChange |
Whether or not to swap display dimensions when the orientation of the phone is changed
| |
TimeDateDropDownUsesSystemColors |
When true, the timedate drop-down UI will use the current "System Colors" (defined by the Operating System).
When false, the timedate drop-down UI will use colors that match Label associated with the TimeDate dynamic (this is the default).
| |
ToolTipOptions |
Options for tooltips.
| |
UseDisabledColors |
True when the alternate colors should be used to indicate that an object is disabled.
| |
UsePointFailColors |
True when the alternate colors should be used to indicate that an dynamic has a bad quality data source.
| |
UsePointFailColorsForUncertainQuality |
True when the alternate colors should be used to indicate that an dynamic has an uncertain quality data source.
| |
UsePointFailText |
True to show the PointFailText to indicate that an object has a bad quality data source.
When false, the last known good/uncertain value will continue to be shown (instead of the PointFailText) when there is a bad quality data source.
| |
UsePointFailTextForUncertainQuality |
True to show the PointFailText to indicate that an object has an uncertain quality data source.
When false, an uncertain value will continue to be shown (instead of the PointFailText).
| |
WebProductName |
Gets the "mobile" product name associated with this component.
| |
ZoomEnabled |
True to enable zooming during runtime, false to disable zooming during runtime.
|
Attached Properties
Name | Description | |
---|---|---|
GwxDocument |
Events
Name | Description | |
---|---|---|
AnimationStarted |
Occurs after a display has started animating.
| |
AnimationStarting |
Occurs before a display starts animating.
| |
AnimationStopped |
Occurs after a display has stopped animating.
| |
AnimationStopping |
Occurs before a display stops animating.
| |
BeginPrint |
Occurs before the first page of the current display prints.
| |
Changed | Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.) | |
CurrentCultureChanged |
Occurs when the current CultureInfo provided by Language Aliasing has changed.
| |
DataReady |
This event occurs when all subscribed data tags have intialially received good quality data values.
This event only occurs once. It will only occur again if ALL data tags are unsubscribed and re-subscribed.
In other words, this event will only happen once in the lifetime of an HMI display, unless the HMI display
exits runtime mode and then subsequently re-enters runtime mode (if only a subset of tags are unsubscribed/re-subscribed,
this event will not be raised).
| |
DataReleased |
Occurs after data has been released for a display.
| |
DataReleasing |
Occurs before data is released for a display.
| |
DataRequested |
Occurs after data has been requested for a display.
| |
DataRequesting |
Occurs before data is requested for a display.
| |
DataValueWriteBeginning |
Occurs when a new value is about to be written.
| |
DataValueWriteCompleted |
Occurs when a new value has been successfully written.
| |
DataValueWriteFailed |
Occurs when a new value has failed to be written.
| |
DocumentUnloading |
Occurs when the currently loaded display is being unloaded
(ususally because a new display has been loaded to replace the current display).
| |
EndPrint |
Occurs after the last page of the current display prints.
| |
LoadCompleted |
Occurs after a display load has finished.
| |
MobileDisplayStyleChanged |
Indicates when the style of the controls of the mobile display has changed.
| |
PanChanged |
Occurs when the current pan (horizontal or vertical scroll) has changed.
| |
PickPostDown |
Occurs when the mouse is pressed down on a Pick dynamic, after the Pick command has executed.
| |
PickPostUp |
Occurs when the mouse is released on a Pick dynamic, after the Pick command has executed.
| |
PickPostWhileDown |
Occurs while the mouse is pressed down on a Pick dynamic (at the configured interval), after the Pick command has executed.
| |
PickPreDown |
Occurs when the mouse is pressed down on a Pick dynamic, before the Pick command has executed.
| |
PickPreUp |
Occurs when the mouse is released on a Pick dynamic, before the Pick command has executed.
| |
PickPreWhileDown |
Occurs while the mouse is pressed down on a Pick dynamic (at the configured interval), before the Pick command has executed.
| |
ScaleChanged |
Occurs when the current scaling of a display changes (caused by zoom change or resize of scalable display).
| |
ViewportSizeChanged |
Occurs when the size the width or height of this viewer's viewport (current view area) has changed.
You can use ThisWindow.ViewportWidth and ThisWindow.ViewportHeight to determine the new viewport size.
Or, you can call ThisWindow.GetCurrentVisibleAreaRootSpace to get the viewport dimensions in the coordinate
space the root visual of the display.
| |
WindowLocationChanged |
Occurs when the location of the window that contains this control has changed.
You can call ThisWindow.GetWindowBounds in the event handler to determine the new window location.
| |
WindowSizeChanged |
Occurs when the size of the window that contains this control has changed.
You can call ThisWindow.GetWindowBounds in the event handler to determine the new window size.
| |
ZoomChanged |
Occurs when the current zoom has changed.
|