Class NSCommandInfo
An instance of this class describes a custom command, declared and implemented by a document plugin.
Constructors
NSCommandInfo()
Initializes a new instance of the NSCommandInfo class.
Declaration
NSCommandInfoMethods
GetDisplayName()
Declaration
String GetDisplayName()Examples
NSCommandInfo thing;
String displayName = thing.GetDisplayName();Returns
| Type | Description |
| String | Display name, shown in menus, command lists and similar GUI elements. |
GetDisplayTooltip()
Declaration
String GetDisplayTooltip()Examples
NSCommandInfo thing;
String displayTooltip = thing.GetDisplayTooltip();Returns
| Type | Description |
| String | Tooltip string associate with the command* can be a literal or a tooltip hint. |
GetIconHint()
Declaration
String GetIconHint()Examples
NSCommandInfo thing;
String iconHint = thing.GetIconHint();Returns
| Type | Description |
| String | Icon hint, which should resolve to an icon that is compatible in size with a standard menu or dropdown list font. May be blank. |
GetName()
Declaration
String GetName()Examples
NSCommandInfo thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The programmatic name of the command, uniquely identifying this command for the document plugin. |
GetReturnType()
Declaration
Integer GetReturnType()Examples
NSCommandInfo thing;
Integer returnType = thing.GetReturnType();Returns
| Type | Description |
| Integer | Declaration of what kind of return type the execution of this command will give. See <xref href="CRMScript.NetServer.ReturnType" data-throw-if-not-resolved="false"></xref>. |
SetDisplayName(String)
Declaration
Void SetDisplayName(String displayName)Examples
NSCommandInfo thing;
String displayName;
thing.SetDisplayName(displayName);Parameters
| Type | Name | Description |
| String | displayName | Display name, shown in menus, command lists and similar GUI elements. |
Returns
| Type | Description |
| Void |
SetDisplayTooltip(String)
Declaration
Void SetDisplayTooltip(String displayTooltip)Examples
NSCommandInfo thing;
String displayTooltip;
thing.SetDisplayTooltip(displayTooltip);Parameters
| Type | Name | Description |
| String | displayTooltip | Tooltip string associate with the command - can be a literal or a tooltip hint. |
Returns
| Type | Description |
| Void |
SetIconHint(String)
Declaration
Void SetIconHint(String iconHint)Examples
NSCommandInfo thing;
String iconHint;
thing.SetIconHint(iconHint);Parameters
| Type | Name | Description |
| String | iconHint | Icon hint, which should resolve to an icon that is compatible in size with a standard menu or dropdown list font. May be blank. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSCommandInfo thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The programmatic name of the command, uniquely identifying this command for the document plugin. |
Returns
| Type | Description |
| Void |
SetReturnType(Integer)
Declaration
Void SetReturnType(Integer returnType)Examples
NSCommandInfo thing;
Integer returnType;
thing.SetReturnType(returnType);Parameters
| Type | Name | Description |
| Integer | returnType | Declaration of what kind of return type the execution of this command will give. See <xref href="CRMScript.NetServer.ReturnType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |