Sample: SDK.NavItemSamples.js

Article
10/06/2013

[Applies to: Microsoft Dynamics CRM 2011]

This sample code is for Microsoft Dynamics CRM 2011, and can be found in the following location in the SDK download: SDK\SampleCode\JS\FormScripts\SDK.NavItemSamples.js

Requirements

This sample code represents a JScript library that can be added as a Web resource. Before a function in a JScript library can be used as a form event handler, the JScript library must be added to the form libraries available for that form. The full name of the function must be used in the form event handler. For example, the showNavigationItemInfo function must be called using SDK.NavItemSamples.showNavigationItemInfo().

Demonstrates

This library contains examples of the following Xrm.Page.ui.navigation Item Methods:

Example

//If the SDK namespace object is not defined, create it.
if (typeof (SDK) == "undefined")
{ SDK = {}; }
// Create Namespace container for functions in this library;
SDK.NavItemSamples = {};

 // item.getId() example
 // item.getLabel() example
 // item.getVisible() example
// Example: The SDK.NavItemSamples.showNavigationItemInfo function displays the label, id, and the visibility for every navigation item in a new window
SDK.NavItemSamples.showNavigationItemInfo = function () {
 var html = "<!DOCTYPE html ><html lang='en-US' ><head><title>Navigation Items Info</title>";
 html += "<style type=\"text/css\">body { font-family:Calibri;}";
 html += "table {border:1px solid gray; border-collapse:collapse;}";
 html += "th {text-align:left; border:1px solid gray;}";
 html += "td {border:1px solid gray;}</style>";
 html += "</head><body>";
 html += SDK.NavItemSamples.buildNavigationInfoTable();
 html += "</body></html>";
 var myWindow = window.open("", "_blank", "height=400,width=350,scrollbars=1,resizable=1", false);
 myWindow.document.open();
 myWindow.document.write(html);
 myWindow.document.close();
};

SDK.NavItemSamples.buildNavigationInfoTable = function () {
 var html = "<table summary='This table displays a list of each navigation item in the page.'><thead><tr><th scope='col'>Item Name</th><th scope='col'>Item Id</th><th scope='col'>Is Visible</th></tr></thead><tbody>";
 var items = Xrm.Page.ui.navigation.items.get();

 for (var i in items) {
  var item = items[i];

  html += "<tr><td>" + item.getLabel() + "</td>" +
        "<td>" + item.getId() + "</td>" +
        "<td>" + item.getVisible() + "</td>";
 }
 html += "</tbody></table>";
 return html;
};

 // item.setFocus() example
// Example: The SDK.NavItemSamples.setFocusDemo function will open a new page containing a table with rows for each visible navigation item.
 // Each row contains a button that will use the window.opener to access the Xrm.Page object to call the setFocus method 
 // for the navigation item in the entity record form.
SDK.NavItemSamples.setFocusDemo = function () {
 var html = "<!DOCTYPE html ><html lang='en-US' ><head><title>Set focus demo</title>";
 html += "<style type=\"text/css\">body { font-family:Calibri;}";
 html += "table {border:1px solid gray; border-collapse:collapse;}";
 html += "th {text-align:left; border:1px solid gray;}";
 html += "td {border:1px solid gray;}</style>";
 html += "<script type=\"text/javascript\" >";
 html += "function setFocus(id) { ";
 html += "\n\r";
 html += "window.opener.Xrm.Page.ui.navigation.items.get(id).setFocus();";
 html += "\n\r";
 html += "}";
 html += "</script>";
 html += "</head><body>";
 html += SDK.NavItemSamples.buildFocusTable();
 html += "</body></html>";
 var theWindow = window.open("", "_blank", "height=400,width=350,scrollbars=1,resizable=1", false);
 theWindow.document.open();
 theWindow.document.write(html);
 theWindow.document.close();
};

SDK.NavItemSamples.buildFocusTable = function () {
 var html = "<table summary='This table displays a list of each navigable navigation item and a button to call setFocus on the item.'><thead><tr><th scope='col'>Item Label</th><th scope='col'>Set Focus</th>" +
    "</tr></thead><tbody>";
 var items = Xrm.Page.ui.navigation.items.get();

 for (var i in items) {
  var item = items[i];
  //setFocus will cause an error if used on an item that is not visible.
  if (item.getVisible()) {
   var itemLabel = item.getLabel();
   var itemId = item.getId();

   html += "<tr><td>" + itemLabel +
         "</td><td><input type=\"button\" onclick=\"setFocus('" + itemId +
          "');\" value='Set Focus on " + itemLabel + "' /></td></tr>";
  }
 }
 html += "</tbody></table>";
 return html;
};

 // item.setLabel() example
// Example: The SDK.NavItemSamples.toggleItemLabels function will show or hide a specified prefix for all navigation items on the form.
SDK.NavItemSamples.toggleItemLabels = function (prefix) {
 var items = Xrm.Page.ui.navigation.items.get();

 for (var i in items) {
  var item = items[i];
  var currentLabel = item.getLabel();
  if (currentLabel.substring(0, prefix.length) == prefix) {
   var newLabel = currentLabel.substring(prefix.length);
   item.setLabel(newLabel);
  }
  else {
   item.setLabel(prefix + currentLabel);
  }
 }
};

 // item.setVisible() example
// Example: The SDK.NavItemSamples.toggleVisibleItems function hides or reveals all navigationitems on the form each time the event occurs.
SDK.NavItemSamples.toggleVisibleItems = function () {
 var items = Xrm.Page.ui.navigation.items.get();

 for (var i in items) {
  var item = items[i];
  if (item.getVisible()) {
   item.setVisible(false);
  }
  else {
   item.setVisible(true);
  }
 }
};
 //End of NavItem Samples Functions

Sample: SDK.NavItemSamples.js

Requirements

Demonstrates

Example

See Also

Reference

Concepts

Other Resources

Additional resources