Documentation

GetNavChain

string
CMain::GetNavChain(
 mixed path = false,
 int NumFrom = 0, 
 mixed NavChainPath = false,
 bool IncludeOnce=false,
 bool ShowIcons = true
)

The method returns the HTML code of the navigation chain.

If you do not want some page to display the navigation chain, simply initialise the page property NOT_SHOW_NAV_CHAIN with "Y":

$APPLICATION->SetPageProperty("NOT_SHOW_NAV_CHAIN", "Y");
The method supports this property and respects its value.

Non-static method.

Parameters

ParameterDescription Available from version
path Path for which the navigation chain is to be built. In case of multiple sites, if the DOCUMENT_ROOT of the site is different (specified in the "Path to the root web server folder" field in the site settings), pass an array in the following format:
array("site ID", "path")
Optional parameter. False by default - which means the current site.
NumFrom Ordinal of item from which to build the chain.
Optional parameter. Optional; null by default.
NavChainPath Path to the navigation chain template.
Optional parameter. The default value is false, which implies searching for the navigation chain template using the algorithm described in the Navigation chain section.>
IncludeOnce Optional parameter. False by default. Chain creation in the edit mode with the parameter ShowIcons=true is unavailable.
ShowIcons Flag to show an icon. Optional. True by default.

See Also



© «Bitrix24», 2001-2022
Up