Project::GetFolderWithPage

GetFolderWithPage

Description

Find the folder that contains the page with the given name, and return the folder.

Find the folder that contains a given page.

Syntax

Folder GetFolderWithPage( LPCSTR lpcszWindowName )

Folder GetFolderWithPage( PageBase & page )

Parameters

lpcszWindowName

[input]the name of the page.

page

[input]the page.

Return

the Folder containing the page with the name lpcszWindowName.

the Folder containing the page.

Examples

EX1

// For this example to run, create a folder in the project and make
// sure that the folder contains a graph with the name "Graph1".
void    Project_GetFolderWithPage_Ex1()
{
    Folder            fld = Project.GetFolderWithPage("Graph1");
    
    if (fld.IsValid())    // if the page was found
    {
        // Display the name of the folder containing the page (window) "Graph1".
        out_str(fld.GetName());
    }
    else        // the page was not found
        out_str("The page was not found!");
}

EX2

// For this example to run, create a folder in the project and make
// sure that the folder contains a graph with the name "Graph1".
void    Project_GetFolderWithPage_Ex2()
{
    Page            pg("Graph1");
    
    Folder            fld = Project.GetFolderWithPage(pg);
    
    if (fld.IsValid())    // if the page was found
    {
        // Display the name of the folder containing the page (window) "Graph1".
        out_str(fld.GetName());
    }
    else        // the page was not found
        out_str("The page was not found!");
}

Remark

See Also

Project::DatasetNames,Project::GraphPages,Project::LayoutPages,Project::LooseDatasetNames,Project::MatrixPages,Project::Notes, Project::Pages, Project::WorksheetPages

header to Include

origin.h