GetActiveSheet PowerScript function

Description

Returns the currently active sheet in an MDI frame window.

Controls

MDI frame windows

Syntax

<span>mdiframewindow</span>.<span>GetActiveSheet</span> ( )

1	<span>mdiframewindow</span>.<span>GetActiveSheet</span> ( )

Argument	Description
mdiframewindow	The MDI frame window for which you want the active sheet

Return Values

Window. Returns the sheet that is currently active in mdiframewindow.
If no sheet is active, GetActiveSheet returns
an invalid value. If mdiframewindow is null, GetActiveSheet returns null.

Usage

Use the IsValid function to determine whether GetActiveSheet has
returned a valid window value.

Examples

These statements determine the active sheet in the
MDI frame window w_frame and change
the text of the menu selection m_close on
the menu m_file on the menu bar m_main.
If no sheet is active, the text is Close Window:

// Declare variable for active sheet

1	// Declare variable for active sheet

window activesheet

1	window activesheet

string mtext

1	string mtext

activesheet = w_frame.<span>GetActiveSheet</span>()

1	activesheet = w_frame.<span>GetActiveSheet</span>()

IF IsValid(activesheet) THEN

1	IF IsValid(activesheet) THEN

    // There is an active sheet, so get its title;

1	// There is an active sheet, so get its title;

    // change the text of the menu to read

1	// change the text of the menu to read

    // Close plus the title of the active sheet

1	// Close plus the title of the active sheet

    mtext = "Close " + activesheet.Title

1	mtext = "Close " + activesheet.Title

    m_main.m_file.m_close.Text = mtext

1	m_main.m_file.m_close.Text = mtext

ELSE

ELSE

    // No sheet is active, menu says Close Window

1	// No sheet is active, menu says Close Window

    m_main.m_file.m_close.Text = "Close Window"

1	m_main.m_file.m_close.Text = "Close Window"

END IF

END IF

August 20, 2023

Was this article helpful?

Connection Information

GetActiveSheet – PB Docs 150