JVCL Help:TJvCustomNavigationPane.HidePage@TJvCustomPage

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Hides the specified page in the page list.


Pascal

 functionHidePage(Page: TJvCustomPage): TJvCustomPage; override;


Parameters

Parameters Description
Page: TJvCustomPage Description for this parameter


Return Value

TJvCustomPage - Updated page or Nil when not owned by the current page list.


Description

HidePage is a TJvCustomPage function that moves the page specified in Page to the internal list of hidden (non-visible) pages. When Page has been assigned, and is owned by the current page list, the return value for the method is the page instance after clearing the owner of the page instance. Otherwise the return value is Nil. HidePage tries to select the next visible page in the list when ActivePage contains the page instance to be hidden. If no other page is available, ActivePage is set to the value Nil. After calling HidePage, the page can no longer be accessed using the PrevPage and NextPage navigation methods. Use ShowPage to move a page to the list of visible pages in the page list.


See Also

TJvCustomPage, TJvCustomPageList.ShowPage, TJvCustomPageList.PrevPage, TJvCustomPageList.NextPage


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page