Class NSCommandInfo

An instance of this class describes a custom command, declared and implemented by a document plugin.

Syntax

Constructors

NSCommandInfo()

Initializes a new instance of the NSCommandInfo class.

Declaration

NSCommandInfo

Methods

GetDisplayName()

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

String GetDisplayName()

Returns

Type	Description
String	Display name, shown in menus, command lists and similar GUI elements.

Examples

NSCommandInfo thing;
String displayName = thing.GetDisplayName();

GetDisplayTooltip()

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

String GetDisplayTooltip()

Returns

Type	Description
String	Tooltip string associate with the command* can be a literal or a tooltip hint.

Examples

NSCommandInfo thing;
String displayTooltip = thing.GetDisplayTooltip();

GetIconHint()

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

String 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.

Examples

NSCommandInfo thing;
String iconHint = thing.GetIconHint();

GetName()

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

String GetName()

Returns

Type	Description
String	The programmatic name of the command, uniquely identifying this command for the document plugin.

Examples

NSCommandInfo thing;
String name = thing.GetName();

GetReturnType()

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Integer GetReturnType()

Returns

Type	Description
Integer	Declaration of what kind of return type the execution of this command will give. See ReturnType.

Examples

NSCommandInfo thing;
Integer returnType = thing.GetReturnType();

SetDisplayName(String)

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Void SetDisplayName(String displayName)

Parameters

Type	Name	Description
String	displayName	Display name, shown in menus, command lists and similar GUI elements.

Returns

Type	Description
Void

Examples

NSCommandInfo thing;
String displayName;
thing.SetDisplayName(displayName);

SetDisplayTooltip(String)

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Void SetDisplayTooltip(String 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

Examples

NSCommandInfo thing;
String displayTooltip;
thing.SetDisplayTooltip(displayTooltip);

SetIconHint(String)

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Void SetIconHint(String 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

Examples

NSCommandInfo thing;
String iconHint;
thing.SetIconHint(iconHint);

SetName(String)

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Void SetName(String 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

Examples

NSCommandInfo thing;
String name;
thing.SetName(name);

SetReturnType(Integer)

An instance of this class describes a custom command, declared and implemented by a document plugin.

Declaration

Void SetReturnType(Integer returnType)

Parameters

Type	Name	Description
Integer	returnType	Declaration of what kind of return type the execution of this command will give. See ReturnType.

Returns

Type	Description
Void

Examples

NSCommandInfo thing;
Integer returnType;
thing.SetReturnType(returnType);