UnloadDisplay method
Unloads the specified display. If the display is cached, it will be removed from the cache.
If the
Unload
method is used with no arguments, all displays are unloaded.When this method is called, the following events will occur in the indicated order:
- If the display is the active: Display_Deactivate
- If the display is animating: Display_BeforeAnimationStop
- Display_Unload
- Application_DisplayUnload
Syntax
Application
.UnloadDisplay
[Name
], [AllInstances
]where
Application
– is the name of a FactoryTalk View SE
Client Application object or an expression that evaluates to a FactoryTalk View SE
Client Application object.Name
– is a string that specifies the name of the display. In a distributed application, the name may be fully qualified. If it is not, the Current Area will be used to resolve the display name.AllInstances
– is an optional Boolean parameter that, when True, unloads all instances of the display specified by Name if multiple instances are loaded. The default value for AllInstances is True.Remarks
- If a display with the specified Name is not found, no error occurs.
- No security checking is performed before unloading a display.
- If the display is referenced multiple times (for example, by another object variable), it will still be unloaded and any subsequent accessing of the unloaded display will cause an error.
- If the display is in the process of being printed via the PrintDisplay command, it will not be unloaded until it is finished printing but it will be made invisible.
- When testing the animation in displays in the Graphic Display editor, calls to this method raise an error with Err.Number equal to gfxErrorTestAnimation.
Provide Feedback