GetFrame

<< Click to Display Table of Contents >>

 

GetFrame

GetFrame([FrameName], [CreateNew])

This method searches for a Splitter object already open in the current Elipse Power Viewer. This method contains a FrameName parameter, which is optional and determines a Frame's name to search for, and CreateNew, which is also optional and determines whether a new window must be created. If the value specified in FrameName is omitted or an empty String, it returns a Frame that contains all Splitters or the active Screen. If the CreateNew parameter is omitted or configured as True, a new window is created. With this method's return value, use Splitter methods, for example the OpenScreen method, to open another Screen. The next code contains a usage example of this method.

Sub Button1_Click()
  ' When clicking this Button, gets the 'Menu' Frame
  ' and replaces the current Screen of this Frame
  ' by the 'Options' Screen
  Set newFrame = Application.GetFrame("Menu")
  ' newFrame contains a Splitter-type object
  newFrame.OpenScreen "Options", 0
End Sub

 

NOTE

If the name passed in the FrameName parameter refers to a non-existing Frame and the CreateNew parameter is configured as False, this method returns Nothing, that is, it does not return any Frame.

Was this page useful?