2.2.4.34.9 PageBase::GetShow

GetShow

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Get the show state of the page.

Syntax

int GetShow(BOOL bRestrictCheck = FALSE)

Parameters

bRestrictCheck: [input] if set as TRUE, will get the actual state of the page even if it is not in active folder, if set as FALSE, will always return PAGE_NORMAL when the page is not in active folder.

Return

Returns one of the following values: PAGE_NORMAL, PAGE_MINIMIZED, PAGE_MAXIMIZED, and PAGE_HIDDEN

Examples

EX1

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