Intersoft ClientUI Documentation
SynchronizeNavigateUri Property



Intersoft.Client.UI.Aqua.UXCollection Namespace > UXNavigationPaneItem Class : SynchronizeNavigateUri Property
Gets or sets a value that indicates whether the navigation item should automatically synchronize its state to match the state of the target navigation host.
Syntax
Public Property SynchronizeNavigateUri As Boolean
Dim instance As UXNavigationPaneItem
Dim value As Boolean
 
instance.SynchronizeNavigateUri = value
 
value = instance.SynchronizeNavigateUri
public bool SynchronizeNavigateUri {get; set;}
public:
property bool SynchronizeNavigateUri {
   bool get();
   void set (    bool value);
}
Remarks

In addition to the basic navigation capability such as explained in the earlier section, UXNavigationPane also supports many of the advanced features available in ClientUI navigation framework. One of the noteworthy features is the automatic synchronization with the current navigation URI.

When the NavigateUri property of UXNavigationPaneItem is specified and target a navigation frame that integrated to browser, the item will perform page navigation when it is selected. More importantly, the UXNavigationPaneItem will also be consistently selected when users navigate to a page that matches the item's NavigateUri through other means, such as typing directly in the browser's address bar, loading the page from browser's bookmark, or navigate to the page from other navigation source. In addition, the nested navigation source within the selected item will also be automatically synchronized to ensure consistent navigation experiences. To be more exact, the supported navigation source includes all controls that implement INavigationSource such as UXNavigationButton, UXToolBarButton, as well as UXTreeViewItem.

UXNavigationPane also supports the scenario where the NavigateUri property value might differ with the base navigation state to synchronize during page navigation. For examples, consider a scenario where the Mail item should navigate to /Mail/Inbox when clicked. However, the desired navigation state for synchronization is /Mail, so that page navigation to either /Mail, /Mail/Outbox, or /Mail/Follow-ups will automatically select the Mail item. To achieve this scenario, you set the NavigationState property of the UXNavigationPaneItem to the desired value that represents the base navigation URI to synchronize.

Example
XAML
Copy Code 
<Intersoft:UXNavigationPane>

    <Intersoft:UXNavigationPaneItem Header="Overview" NavigateUri="/Overview/Home" NavigationState="/Overview" IsDefaultNavigationSource="True" Icon="Assets/Images/Home.png">
        ...
    </Intersoft:UXNavigationPaneItem>
    
    <Intersoft:UXNavigationPaneItem Header="Mail" NavigateUri="/Mail/Inbox" NavigationState="/Mail" Icon="Assets/Images/Email.png">
        ...
    </Intersoft:UXNavigationPaneItem>

    <Intersoft:UXNavigationPaneItem Header="Contacts" NavigateUri="/Contacts/All" NavigationState="/Contacts" Icon="Assets/Images/Contact.png">
        ...
    </Intersoft:UXNavigationPaneItem>

<Intersoft:UXNavigationPane>
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

UXNavigationPaneItem Class
UXNavigationPaneItem Members

Send Feedback