canRun Method

Summary

Checks if a command can run with the specified optional value.

Syntax

JavaScript Syntax
DocumentViewerCommands.prototype.canRun = function( 
   commandName, 
   value 
)
TypeScript Syntax
canRun( 
   commandName: string, 
   value: any 
): boolean;

Parameters

commandName

Command name

value

Optional value to pass to the callback

Return Value

true if the command can run with the specified value; otherwise, false.

Remarks

This method checks if the command exists and if it has a CanRunHandler callback value that is not null, if so, it will invoke the callback with value and returns the result.

If the command does not exist or it does not have a handler, then this method returns false - the command cannot run.

Refer to Document Viewer Commands for more information.

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents.UI Assembly
Introduction
Getting Started
Namespaces
Leadtools.Documents.UI Namespace
Assemblies