2.2.4.34.12 PageBase::GetStatus

GetStatus

Description

GetStatus returns the status of the PageBase in the Folder pFolder, or in the current Folder when pFolder is NULL(default).

Syntax

int GetStatus( Folder & fld = NULL, int* pnCurrentIndexInFolder = NULL )

Parameters

fld

[input] the folder where status of the page is requested

pnCurrentIndexInFolder

[output] the display index (0-offset) of the page in the folder as a list. This reflects the current sort order in the folder. This supports the active folder only. For other folders, -1 will be returned.

Return

Returns the status of the PageBase in the Folder pFolder, or in the current Folder when pFolder is NULL(default). Can be one or more of the following:

PBFS_SHORTCUT, PBFS_HIDDEN, PBFS_SELECTED, PBFS_SLIDE_HIDDEN.

Examples

EX1

int PageBase_GetStatus_ex1()
{
    foreach(PageBase pb in Project.Pages)
    {
        if( pb.GetStatus() == PBFS_HIDDEN )
            printf("%s is hidden\n", pb.GetName());
        else
            printf("%s show state is %d\n", pb.GetName(), pb.GetShow());
    }
    return 0;
}

Remark

This is a new method added in Origin 8.1

See Also

Header to Included

origin.h