> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSCommandInfo

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

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

## Constructors

### NSCommandInfo()

```crmscript theme={null}
NSCommandInfo
```

Initializes a new instance of the NSCommandInfo class.

## Methods

## GetDisplayName()

```crmscript theme={null}
String GetDisplayName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Display name, shown in menus, command lists and similar GUI elements.

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String displayName = thing.GetDisplayName();
```

## GetDisplayTooltip()

```crmscript theme={null}
String GetDisplayTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Tooltip string associate with the command\* can be a literal or a tooltip hint.

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String displayTooltip = thing.GetDisplayTooltip();
```

## GetIconHint()

```crmscript theme={null}
String GetIconHint()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.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.

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String iconHint = thing.GetIconHint();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The programmatic name of the command, uniquely identifying this command for the document plugin.

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String name = thing.GetName();
```

## GetReturnType()

```crmscript theme={null}
Integer GetReturnType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.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>.

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
Integer returnType = thing.GetReturnType();
```

## SetDisplayName(String)

```crmscript theme={null}
Void SetDisplayName(String displayName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String displayName;
thing.SetDisplayName(displayName);
```

## SetDisplayTooltip(String)

```crmscript theme={null}
Void SetDisplayTooltip(String displayTooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String displayTooltip;
thing.SetDisplayTooltip(displayTooltip);
```

## SetIconHint(String)

```crmscript theme={null}
Void SetIconHint(String iconHint)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String iconHint;
thing.SetIconHint(iconHint);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
String name;
thing.SetName(name);
```

## SetReturnType(Integer)

```crmscript theme={null}
Void SetReturnType(Integer returnType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSCommandInfo thing;
Integer returnType;
thing.SetReturnType(returnType);
```


## Related topics

- [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [SuperOffice.WebApi.Data.CommandInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.CommandInfo.md)
- [Execute Document Command](/en/api/reference/restful/rest/document/execute-document-command.md)
- [Git commands](/contribute/git-cheat-sheet.md)
