The GwxDocument 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 methodCreateDelegate
Creates a Delegate of the specified type for the specified script function.
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 methodGetAliasValue
Gets the alias value of the local alias item that has the specified alias name (if there is one).
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 methodGetDataSources
Gets a collection of all of the datasources included in the current display.
Public methodGetDynamicGroupFromTargetName
Retrieve a GwxDynamicGroup object given its associated TargetName
Public methodGetDynamicGroups
Gets an array of all GwxDynamicGroup objects in this display.
Public methodGetDynamicObjectByName
Retrieve a GwxDynamic object given its name.
Public methodGetElementByName
Gets the visual object with the specified name.
Public methodGetElementByTitle
Gets the visual object with the specified title.
Public methodGetElementsByName
Gets a list of visual objects with the specified name.
Public methodGetElementsByTitle
Gets a list of visual objects with the specified title.
Public methodGetExpressionDataSources
Gets a list of all "local-expression" datasources used in the current display.
Public methodGetFileVersion
Gets the version of the application that was used to save the currently loaded file.
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalAliases()()()()
Gets the local aliases currently defined in this display.
Public methodStatic memberGetLocalAliases(String)
Gets the local aliases defined in the display with the specified filename.
Public methodGetLocalAliases(DependencyObject)
Gets the object-level local aliases currently defined for the specified visual object.
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetSimulationDataSources
Gets a list of all "local-simulation" datasources used in the current display.
Public methodGetSourcePath
Gets the path of the currently loaded display (minus the file name).
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 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 methodSetAliasValue(String, String)
Sets the alias value of the local alias item that has the specified alias name (if there is one).
Public methodSetAliasValue(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.
Public methodSetAliasValue(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.
Public methodSetAliasValues(AliasCommandType, String)
Sets local aliases in the display based on the specified command data.
Public methodSetAliasValues(String, AliasCommandType, String)
Sets local aliases for the specified visual object based on the specified command data.
Public methodSetCurrentCultureName
Sets the culture that is used by Language Aliasing.
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
Overrides ToString()()()().
(Overrides Object..::..ToString()()()().)
Public methodVerifyAccess
Enforces that the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)

Fields

  NameDescription
Public fieldStatic memberCachePriorityProperty
DependencyProperty for the CachePriority property.
Public fieldStatic memberDataEntryLostFocusWritesValueProperty
DependencyProperty for the DataEntryLostFocusWritesValue property.
Public fieldStatic memberDefaultViewProperty
DependencyProperty for the DefaultView()()()() property.
Public fieldStatic memberDesiredFrameRateProperty
DependencyProperty for the DesiredFrameRate property.
Public fieldStatic memberDisableControlWhenAnyRelatedDynamicIsDisabledProperty
DependencyProperty for the DisableControlWhenAnyRelatedDynamicIsDisabled property.
Public fieldStatic memberDisableControlWhenReadOnlyDataProperty
DependencyProperty for the DisableControlWhenReadOnlyData property.
Public fieldStatic memberDisableControlWhenSecurityDeniedProperty
DependencyProperty for the DisableControlWhenSecurityDenied property.
Public fieldStatic memberDisabledFillBrushProperty
DependencyProperty for the DisabledFillColor property.
Public fieldStatic memberDisabledFillColorProperty
DependencyProperty for the DisabledFillColor property.
Public fieldStatic memberDisabledLineBrushProperty
DependencyProperty for the DisabledLineColor property.
Public fieldStatic memberDisabledLineColorProperty
DependencyProperty for the DisabledLineColor property.
Public fieldStatic memberEnableControlEventsProperty
DependencyProperty for the EnableControlEvents property.
Public fieldStatic memberGlobalAliasesProperty
DependencyProperty for the DEFAULT_GlobalAliases()()()() property.
Public fieldStatic memberHideDynamicActiveWhenPointFailureExProperty
DependencyProperty for the HideDynamicActiveWhenPointFailureEx property.
Public fieldStatic memberHorizontallyAlignedAdjustableFaceplateScreenHeightProperty
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.
Public fieldStatic memberHorizontallyAlignedAdjustableFaceplateScreenWidthProperty
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.
Public fieldStatic memberHorizontallyAlignedDisplayHeightProperty
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.
Public fieldStatic memberHorizontallyAlignedDisplayWidthProperty
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.
Public fieldStatic memberIsScalableProperty
DependencyProperty for the IsScalable property.
Public fieldStatic memberMaximumZoomProperty
DependencyProperty for the MaximumZoom property.
Public fieldStatic memberMinimumZoomProperty
DependencyProperty for the MinimumZoom property.
Public fieldStatic memberMobileDisplayFaceplateNameProperty
Mobile display faceplate name property for a display. DependencyProperty for the MobileDisplayFaceplateName()()()() property.
Public fieldStatic memberMobileDisplayFaceplateOrientationProperty
Mobile display faceplate orientation property for a display. DependencyProperty for the MobileDisplayFaceplateOrientation()()()() property.
Public fieldStatic memberMobileDisplayFaceplateVisibleProperty
Mobile display faceplate visible property for a display. DependencyProperty for the MobileDisplayFaceplateVisible()()()() property.
Public fieldStatic memberMobileDisplayStyleProperty
DependencyProperty for the MobileDisplayStyle property.
Public fieldStatic memberOrientationLockProperty
DependencyProperty for the OrientationLock property.
Public fieldStatic memberPanEnabledProperty
DependencyProperty for the PanEnabled property.
Public fieldStatic memberPasswordProperty
DependencyProperty for the DEFAULT_Password()()()() property.
Public fieldStatic memberPointFailFillBrushProperty
DependencyProperty for the PointFailFillColor property.
Public fieldStatic memberPointFailFillColorProperty
DependencyProperty for the PointFailFillColor property.
Public fieldStatic memberPointFailLineBrushProperty
DependencyProperty for the PointFailLineColor property.
Public fieldStatic memberPointFailLineColorProperty
DependencyProperty for the PointFailLineColor property.
Public fieldStatic memberPointFailTextProperty
DependencyProperty for the PointFailText property.
Public fieldStatic memberPreferredStretchProperty
DependencyProperty for the PreferredStretch property.
Public fieldStatic memberReleaseOutOfViewDataProperty
DependencyProperty for the ReleaseOutOfViewData property.
Public fieldStatic memberResolveAliasesInDragDropDataSourcesProperty
DependencyProperty for the ResolveAliasesInDragDropDataSources property.
Public fieldStatic memberSafeTouchZoneWarningDurationProperty
DependencyProperty for the SafeTouchZoneWarningDuration property.
Public fieldStatic memberSavePasswordProperty
DependencyProperty for the DEFAULT_SavePassword()()()() property.
Public fieldStatic memberShowControlCursorProperty
DependencyProperty for the ShowControlCursor property.
Public fieldStatic memberShowControlFocusProperty
DependencyProperty for the ShowControlFocus property.
Public fieldStatic memberSwapDimensionsOnOrientationChangeProperty
DependencyProperty for the SwapDimensionsOnOrientationChange property.
Public fieldStatic memberUseDisabledColorsProperty
DependencyProperty for the UseDisabledColors property.
Public fieldStatic memberUsePointFailColorsForUncertainQualityProperty
DependencyProperty for the UsePointFailColorsForUncertainQuality property.
Public fieldStatic memberUsePointFailColorsProperty
DependencyProperty for the UsePointFailColors property.
Public fieldStatic memberUsePointFailTextForUncertainQualityProperty
DependencyProperty for the UsePointFailTextForUncertainQuality property.
Public fieldStatic memberUsePointFailTextProperty
DependencyProperty for the UsePointFailText property.
Public fieldStatic memberZoomEnabledProperty
DependencyProperty for the ZoomEnabled property.

Properties

  NameDescription
Public propertyAnimated
True if in runtime mode, false otherwise
Public propertyCachePriority
When the available cache space is running low, this option determines which displays will be removed from the cache first.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyStatic memberCompanyName
Gets the name of the company or creator of this component.
Public propertyConfiguration
Gets the instance of GwxConfiguration associated with this document (if available).
Public propertyCurrentCulture
Gets the current CultureInfo provided by Language Aliasing.
Public propertyCustomFonts
Custom fonts that are available to use in this display.
Public propertyCustomViews
Custom views that are used to change the current zoom and pan when selected by the user.
Public propertyDataEntryLostFocusWritesValue
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.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDesiredFrameRate
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).
Public propertyDisableControlWhenAnyRelatedDynamicIsDisabled
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.
Public propertyDisableControlWhenReadOnlyData
Disables controllable dynamics that reference readonly DataSources.
Public propertyDisableControlWhenSecurityDenied
Disables controllable dynamics when security permission is denied.
Public propertyDisabledFillBrush
Alternate color to indicate that an object is disabled.

Currently only supports SolidColorBrush.

Public propertyDisabledFillColor
Alternate color to indicate that an object is disabled.
Public propertyDisabledLineBrush
Alternate color to indicate that an object is disabled.

Currently only supports SolidColorBrush.

Public propertyDisabledLineColor
Alternate color to indicate that an object is disabled.
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyDisplayTabs
Tabs used to load display files.
Public propertyEnableControlEvents
True to enable execution of commmands when events occur.
Public propertyFocusBorderOptions
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.
Public propertyGlobalAliases
The global aliases to set when opening the display in runtime.
Public propertyHideDynamicActiveWhenPointFailureEx
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").

Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsScalable
True to make this display scalable when it is loaded. False for a fixed-scale display.
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyMaximumZoom
The maximum allowed zoom.
Public propertyMinimumZoom
The minimum allowed zoom.
Public propertyMobileDisplayStyle
Whether or not to swap display dimensions when the orientation of the phone is changed
Public propertyStatic memberMobileProductName
Gets the "mobile" product name associated with this component.
Public propertyOrientationLock
The orientation lock of the phone
Public propertyPanEnabled
True to enable panning/scrolling during runtime, false to disable panning/scrolling during runtime.
Public propertyPassword
The password required to allow this display to be loaded in configuration mode.
Public propertyPointFailFillBrush
Alternate color to indicate that an object has a bad quality data source.

Currently only supports SolidColorBrush.

Public propertyPointFailFillColor
Alternate color to indicate that an object has a bad quality data source.
Public propertyPointFailLineBrush
Alternate color to indicate that an objec thas a bad quality data source.

Currently only supports SolidColorBrush.

Public propertyPointFailLineColor
Alternate color to indicate that an objec thas a bad quality data source.
Public propertyPointFailText
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).
Public propertyPreferredStretch
The stretch mode to use for scalable displays and "Fit to Window" operations.
Public propertyStatic memberProductName
Gets the product name associated with this component.
Public propertyStatic memberProductVersion
Gets the version of this component.
Public propertyReleaseOutOfViewData
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.
Public propertyResolveAliasesInDragDropDataSources
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).
Public propertyRootVisual
Visual that is the visual root for the currently loaded display.
Public propertyRuntimeWindowProperties
Window properties for runtime mode.
Public propertySafeTouchZoneWarningDuration
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.
Public propertyScanRate
The default scan rate (in milliseconds) for requested data values.
Public propertyShowControlCursor
True to show alternate mouse cursor when hovering over a controllable dynamic object.
Public propertyShowControlFocus
True to show a highlight indicator around controllable dynamics that have keyboard focus.
Public propertySource
The uri of the current display
Public propertySpecifyRuntimeWindowProperties
True to specify non-default window properties for runtime mode.
Public propertyStateFieldDropDownUsesSystemColors
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).
Public propertyStoreConfigurationGridSettings
True to indicate that the configuration grid settings should be stored in the display file.
Public propertySwapDimensionsOnOrientationChange
Whether or not to swap display dimensions when the orientation of the phone is changed
Public propertyTimeDateDropDownUsesSystemColors
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).
Public propertyToolTipOptions
Options for tooltips.
Public propertyUseDisabledColors
True when the alternate colors should be used to indicate that an object is disabled.
Public propertyUsePointFailColors
True when the alternate colors should be used to indicate that an dynamic has a bad quality data source.
Public propertyUsePointFailColorsForUncertainQuality
True when the alternate colors should be used to indicate that an dynamic has an uncertain quality data source.
Public propertyUsePointFailText
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.
Public propertyUsePointFailTextForUncertainQuality
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).
Public propertyStatic memberWebProductName
Gets the "mobile" product name associated with this component.
Public propertyZoomEnabled
True to enable zooming during runtime, false to disable zooming during runtime.

Attached Properties

  NameDescription
Public attached propertyGwxDocument

Events

  NameDescription
Public eventAnimationStarted
Occurs after a display has started animating.
Public eventAnimationStarting
Occurs before a display starts animating.
Public eventAnimationStopped
Occurs after a display has stopped animating.
Public eventAnimationStopping
Occurs before a display stops animating.
Public eventBeginPrint
Occurs before the first page of the current display prints.
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventCurrentCultureChanged
Occurs when the current CultureInfo provided by Language Aliasing has changed.
Public eventDataReady
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).

Public eventDataReleased
Occurs after data has been released for a display.
Public eventDataReleasing
Occurs before data is released for a display.
Public eventDataRequested
Occurs after data has been requested for a display.
Public eventDataRequesting
Occurs before data is requested for a display.
Public eventDataValueWriteBeginning
Occurs when a new value is about to be written.
Public eventDataValueWriteCompleted
Occurs when a new value has been successfully written.
Public eventDataValueWriteFailed
Occurs when a new value has failed to be written.
Public eventDocumentUnloading
Occurs when the currently loaded display is being unloaded (ususally because a new display has been loaded to replace the current display).
Public eventEndPrint
Occurs after the last page of the current display prints.
Public eventLoadCompleted
Occurs after a display load has finished.
Public eventStatic memberMobileDisplayStyleChanged
Indicates when the style of the controls of the mobile display has changed.
Public eventPanChanged
Occurs when the current pan (horizontal or vertical scroll) has changed.
Public eventPickPostDown
Occurs when the mouse is pressed down on a Pick dynamic, after the Pick command has executed.
Public eventPickPostUp
Occurs when the mouse is released on a Pick dynamic, after the Pick command has executed.
Public eventPickPostWhileDown
Occurs while the mouse is pressed down on a Pick dynamic (at the configured interval), after the Pick command has executed.
Public eventPickPreDown
Occurs when the mouse is pressed down on a Pick dynamic, before the Pick command has executed.
Public eventPickPreUp
Occurs when the mouse is released on a Pick dynamic, before the Pick command has executed.
Public eventPickPreWhileDown
Occurs while the mouse is pressed down on a Pick dynamic (at the configured interval), before the Pick command has executed.
Public eventScaleChanged
Occurs when the current scaling of a display changes (caused by zoom change or resize of scalable display).
Public eventViewportSizeChanged
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.

Public eventWindowLocationChanged
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.

Public eventWindowSizeChanged
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.

Public eventZoomChanged
Occurs when the current zoom has changed.

See Also