isEnabled Property

Summary

Indicates if this item is enabled.

Syntax
TypeScript
JavaScript
Object.defineProperty(ImageViewerItem.prototype, 'isEnabled', 
	get: function(), 
	set: function(value) 
) 
isEnabled: boolean; 

Property Value

true if this item is enabled; otherwise, false. The default value is true.

Remarks

Inactive items (the value of IsEnabled is false), are rendered and participate in layout calculations but do not respond to interactive mode events.

For more information, refer Image Viewer Items, Image Viewer Layouts, Image Viewer Rendering, and Image Viewer Interactive Modes.

Example

In this example, multiple items are added to the viewer and the selection interactive mode is set. The second item (index 1) is disabled, so it cannot be selected or hovered.

IsEnabled.ts
ImageViewer.ts
IsEnabled.js
ImageViewer.js
IsEnabled.html
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewerItem_IsEnabledExample { 
   private viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   private run = (viewer: lt.Controls.ImageViewer) => { 
      viewer.beginUpdate(); 
      viewer.items.clear(); 
 
      // Change the layout to multi-item 
      viewer.viewLayout = new lt.Controls.ImageViewerVerticalViewLayout(); 
      viewer.itemBorderThickness = 5; 
      viewer.itemPadding = lt.Controls.ControlPadding.createAll(20); 
      viewer.itemSpacing = lt.LeadSizeD.create(10, 10); 
      // Selected items will have a green border 
      viewer.selectedItemBorderColor = "lightgreen"; 
      viewer.hoveredItemBorderColor = "orange"; 
 
      // Add a few more items 
      for (let i = 0; i < 4; i++) { 
         const item: lt.Controls.ImageViewerItem = new lt.Controls.ImageViewerItem(); 
         item.url = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
         item.text = "Item " + i; 
         viewer.items.add(item); 
      } 
 
      // Zoom out so we can see more of the items 
      viewer.zoom(lt.Controls.ControlSizeMode.none, .5, viewer.defaultZoomOrigin); 
 
      // Clear the interactive modes and add one selection mode with rubberband multi-selection support 
      viewer.interactiveModes.clear(); 
      const selectItemsMode: lt.Controls.ImageViewerSelectItemsInteractiveMode = new lt.Controls.ImageViewerSelectItemsInteractiveMode(); 
      selectItemsMode.selectionMode = lt.Controls.ImageViewerSelectionMode.multi; 
      viewer.interactiveModes.add(selectItemsMode); 
 
      viewer.endUpdate(); 
 
      // Make the second (index 1) item disabled so it cannot be selected. 
      const item: lt.Controls.ImageViewerItem = viewer.items.item(1); 
      item.isEnabled = false; 
      const output = document.getElementById("output"); 
      output.innerHTML = "Item 1 is disabled."; 
   } 
} 
export class ImageViewer_Example { 
   // LEADTOOLS ImageViewer to be used with this example 
   protected imageViewer: lt.Controls.ImageViewer = null; 
   // Generic state value used by the examples 
   public timesClicked: number = 0; 
 
   constructor(callback?: (viewer: lt.Controls.ImageViewer) => void) { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
 
      // Create an image viewer inside the imageViewerDiv element 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions: lt.Controls.ImageViewerCreateOptions = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      this.imageViewer = new lt.Controls.ImageViewer(createOptions); 
      this.imageViewer.viewVerticalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.viewHorizontalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.autoCreateCanvas = true; 
 
      // Add Pan/Zoom interactive mode 
      // Click and drag to pan, CTRL-Click and drag to zoom in and out 
      this.imageViewer.interactiveModes.add(new lt.Controls.ImageViewerPanZoomInteractiveMode()); 
 
      // Load an image 
      this.imageViewer.imageUrl = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
 
      this.imageViewer.zoom(lt.Controls.ControlSizeMode.fit, .9, this.imageViewer.defaultZoomOrigin); 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.addEventListener("click", () => { 
         this.timesClicked++; 
         // Run the example 
         if (callback) 
            callback(this.imageViewer); 
      }); 
   } 
} 
import { ImageViewer_Example } from "../ImageViewer"; 
 
export class ImageViewerItem_IsEnabledExample { 
   viewerExample; 
   constructor() { 
      this.viewerExample = new ImageViewer_Example(this.run); 
   } 
 
   run = (viewer) => { 
      viewer.beginUpdate(); 
      viewer.items.clear(); 
 
      // Change the layout to multi-item 
      viewer.viewLayout = new lt.Controls.ImageViewerVerticalViewLayout(); 
      viewer.itemBorderThickness = 5; 
      viewer.itemPadding = lt.Controls.ControlPadding.createAll(20); 
      viewer.itemSpacing = lt.LeadSizeD.create(10, 10); 
      // Selected items will have a green border 
      viewer.selectedItemBorderColor = "lightgreen"; 
      viewer.hoveredItemBorderColor = "orange"; 
 
      // Add a few more items 
      for (let i = 0; i < 4; i++) { 
         const item = new lt.Controls.ImageViewerItem(); 
         item.url = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
         item.text = "Item " + i; 
         viewer.items.add(item); 
      } 
 
      // Zoom out so we can see more of the items 
      viewer.zoom(lt.Controls.ControlSizeMode.none, .5, viewer.defaultZoomOrigin); 
 
      // Clear the interactive modes and add one selection mode with rubberband multi-selection support 
      viewer.interactiveModes.clear(); 
      const selectItemsMode = new lt.Controls.ImageViewerSelectItemsInteractiveMode(); 
      selectItemsMode.selectionMode = lt.Controls.ImageViewerSelectionMode.multi; 
      viewer.interactiveModes.add(selectItemsMode); 
 
      viewer.endUpdate(); 
 
      // Make the second (index 1) item disabled so it cannot be selected. 
      const item = viewer.items.item(1); 
      item.isEnabled = false; 
      const output = document.getElementById("output"); 
      output.innerHTML = "Item 1 is disabled."; 
   } 
} 
export class ImageViewer_Example { 
   // LEADTOOLS ImageViewer to be used with this example 
   imageViewer = null; 
   // Generic state value used by the examples 
   timesClicked = 0; 
 
   constructor(callback) { 
      // Set the LEADTOOLS license. Replace this with your actual license file 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
 
      // Create an image viewer inside the imageViewerDiv element 
      const imageViewerDiv = document.getElementById("imageViewerDiv"); 
      const createOptions = new lt.Controls.ImageViewerCreateOptions(imageViewerDiv); 
      this.imageViewer = new lt.Controls.ImageViewer(createOptions); 
      this.imageViewer.viewVerticalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.viewHorizontalAlignment = lt.Controls.ControlAlignment.center; 
      this.imageViewer.autoCreateCanvas = true; 
 
      // Add Pan/Zoom interactive mode 
      // Click and drag to pan, CTRL-Click and drag to zoom in and out 
      this.imageViewer.interactiveModes.add(new lt.Controls.ImageViewerPanZoomInteractiveMode()); 
 
      // Load an image 
      this.imageViewer.imageUrl = "https://demo.leadtools.com/images/jpeg/cannon.jpg"; 
 
      this.imageViewer.zoom(lt.Controls.ControlSizeMode.fit, .9, this.imageViewer.defaultZoomOrigin); 
 
      const exampleButton = document.getElementById("exampleButton"); 
      exampleButton.addEventListener("click", () => { 
         this.timesClicked++; 
         // Run the example 
         if (callback) 
            callback(this.imageViewer); 
      }); 
   } 
} 
<!doctype html> 
<html lang="en"> 
<title>Controls Example | IsEnabled</title> 
 
<head> 
   <script src="https://code.jquery.com/jquery-2.2.4.min.js" 
      integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
 
   <script src="../../LT/Leadtools.js"></script> 
   <script src="../../LT/Leadtools.Controls.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Engine.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Designers.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Automation.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Main.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Color.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Core.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Effects.js"></script> 
   <script src="../../LT/Leadtools.Document.js"></script> 
   <script src="../../LT/Leadtools.Document.Viewer.js"></script> 
   <style> 
      body { 
         font-family: 'Segoe UI', sans-serif; 
      } 
 
      #imageViewerDiv { 
         border: 1px solid #888; 
         width: 500px; 
         height: 500px; 
         background-color: #eee; 
      } 
   </style> 
 
   <!-- All demo files are bundled and appended to the window --> 
   <script src="../../bundle.js" type="text/javascript"></script> 
</head> 
 
<body> 
   <p>Press and drag on the image to pan.</p> 
   <p>Hold down the control key and press and drag on the image or pinch with two fingers to zoom in and out.</p> 
   <div> 
      <button type="button" id="exampleButton">Run Example</button> 
   </div> 
   <div id="imageViewerDiv"></div> 
   <div id="output"></div> 
</body> 
 
<script> 
   window.onload = () => { 
      const example = new window.examples.ImageViewerItem.IsEnabled(); 
 
   }; 
</script> 
</html> 
Requirements
Target Platforms
Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.