LoadDisplay method
Loads the specified display and returns a Display object that represents the display that was loaded.
This method is equivalent to issuing the
Display
command with the /Z
parameter (that is, caching the display). The display is not made visible (that is. it remains cached) until the Visible
property is set to True. Also, the display is not animating (updating).When this method is called, the following events will occur in this order:
- Application_DisplayLoad
- Display_Load
Syntax
Application
.LoadDisplay
Name
, [Options
]or
Set
oDisplay = Application.LoadDisplay(Name,
[Options
])where
oDisplay
– is the name of a Display object variable.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.Options
– is an optional string containing any of the command line parameters that can be used with the Display command. Because this method essentially caches the display, the /Z and /ZA parameters are ignored.Remarks
- If the display specified by Name is not found an error is raised with Err.Number equal to gfxErrorDisplayNotFound.
- If a display with the specified name is already loaded and multiple running copies are allowed, a new instance of the display is loaded and returned. If multiple running copies are not allowed, the previously loaded display is returned.
- If the current user does not have the security code to access the display, or to access the Display command, the display will not be loaded and an error is raised with Err.Number equal to gfxErrorSecurityAccess.
- When a display is not animating, ActiveX controls are not activated and interaction with them may be limited.
- 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