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

# <a id="SuperOffice_WebApi_Data_CustomCommand" /> Class CustomCommand

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

Carrier object for CustomCommand.
Generic carrier object for entity commands.

```csharp theme={null}
public class CustomCommand : Carrier
```

#### Inheritance

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

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[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_CustomCommand__ctor" /> CustomCommand()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_CustomCommand_ActionData" /> ActionData

The data to be used when the command is invoked

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CustomCommand_Actions" /> Actions

The actions to call when invoked
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[CustomCommand](SuperOffice.WebApi.Data.CustomCommand.md).[Actions\_String](SuperOffice.WebApi.Data.CustomCommand.md#SuperOffice_WebApi_Data_CustomCommand_Actions_String)

### <a id="SuperOffice_WebApi_Data_CustomCommand_Actions_String" /> Actions\_String

The actions to call when invoked
Raw string enum value.

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

#### Property Value

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

#### See Also

[CustomCommand](SuperOffice.WebApi.Data.CustomCommand.md).[Actions](SuperOffice.WebApi.Data.CustomCommand.md#SuperOffice_WebApi_Data_CustomCommand_Actions)

### <a id="SuperOffice_WebApi_Data_CustomCommand_Description" /> Description

Description of the command.

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

#### Property Value

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

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

The name to show in GUI

```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_CustomCommand_Name" /> Name

Unique name of the command

```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_CustomCommand_ToolTip" /> ToolTip

Tooltip to be used in the GUI

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

#### Property Value

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


## Related topics

- [SuperOffice.WebApi.Data.User](/en/api/reference/webapi/SuperOffice.WebApi.Data.User.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [SuperOffice.WebApi.Data.CommandInfo](/en/api/reference/webapi/SuperOffice.WebApi.Data.CommandInfo.md)
- [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)
