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

# SuperOffice.WebApi.Data.CommandInfo

# <a id="SuperOffice_WebApi_Data_CommandInfo" /> Class CommandInfo

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

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

```csharp theme={null}
public class CommandInfo
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CommandInfo](SuperOffice.WebApi.Data.CommandInfo.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_CommandInfo__ctor" /> CommandInfo()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public CommandInfo()
```

## Properties

### <a id="SuperOffice_WebApi_Data_CommandInfo_DisplayName" /> DisplayName

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

```csharp theme={null}
public virtual string DisplayName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CommandInfo_DisplayTooltip" /> DisplayTooltip

Tooltip string associate with the command - can be a literal or a tooltip hint.

```csharp theme={null}
public virtual string DisplayTooltip { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CommandInfo_IconHint" /> 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.

```csharp theme={null}
public virtual string IconHint { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CommandInfo_Name" /> Name

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

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CommandInfo_ReturnType" /> ReturnType

Declaration of what kind of return type the execution of this command will give.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ReturnType? ReturnType { get; set; }
```

#### Property Value

[ReturnType](SuperOffice.WebApi.Data.ReturnType.md)?

#### See Also

[CommandInfo](SuperOffice.WebApi.Data.CommandInfo.md).[ReturnType\_String](SuperOffice.WebApi.Data.CommandInfo.md#SuperOffice_WebApi_Data_CommandInfo_ReturnType_String)

### <a id="SuperOffice_WebApi_Data_CommandInfo_ReturnType_String" /> ReturnType\_String

Declaration of what kind of return type the execution of this command will give.
Raw string enum value.

```csharp theme={null}
[JsonProperty("ReturnType")]
public string ReturnType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[CommandInfo](SuperOffice.WebApi.Data.CommandInfo.md).[ReturnType](SuperOffice.WebApi.Data.CommandInfo.md#SuperOffice_WebApi_Data_CommandInfo_ReturnType)

## See Also

[DocumentAgent](SuperOffice.WebApi.Agents.DocumentAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.DocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DocumentAgent.md)
- [SuperOffice.WebApi.Agents.IDocumentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDocumentAgent.md)
- [SuperOffice.WebApi.Data.CommandResult](/en/api/reference/webapi/SuperOffice.WebApi.Data.CommandResult.md)
- [SuperOffice.WebApi.Data.CommandAction](/en/api/reference/webapi/SuperOffice.WebApi.Data.CommandAction.md)
- [SuperOffice.WebApi.Data.CustomCommand](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomCommand.md)
- [SuperOffice.WebApi.Data.CommandActionResult](/en/api/reference/webapi/SuperOffice.WebApi.Data.CommandActionResult.md)