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

# <a id="SuperOffice_WebApi_Data_TaskMenu" /> Class TaskMenu

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

Carrier object for TaskMenu.
Configurable Menu Items are items that will be merged into menus in given area and entity

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.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)

## Examples

Get TaskMenu 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var taskMenu = agent.GetTaskMenu( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_TaskMenu__ctor" /> TaskMenu()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_TaskMenu_ArchiveBehaviour" /> ArchiveBehaviour

None, rightclick on, multiselect
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[ArchiveBehaviour\_String](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_ArchiveBehaviour_String)

### <a id="SuperOffice_WebApi_Data_TaskMenu_ArchiveBehaviour_String" /> ArchiveBehaviour\_String

None, rightclick on, multiselect
Raw string enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[ArchiveBehaviour](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_ArchiveBehaviour)

### <a id="SuperOffice_WebApi_Data_TaskMenu_Area" /> Area

Can be Task or other that can identify which menu recipe to merge the item into

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_CrmScriptId" /> CrmScriptId

The CRMScript or Macro which will be run task item is selected.

```csharp theme={null}
public virtual int CrmScriptId { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_Deleted" /> Deleted

True if deleted

```csharp theme={null}
public virtual bool Deleted { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_Encoding" /> Encoding

Encoding for url
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[Encoding\_String](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_Encoding_String)

### <a id="SuperOffice_WebApi_Data_TaskMenu_Encoding_String" /> Encoding\_String

Encoding for url
Raw string enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[Encoding](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_Encoding)

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

The list item

```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_TaskMenu_ProgId" /> ProgId

String key that can be used to uniquely retrieve the task menu; particularly useful for partners and others who do not wish to store database ID's

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_Rank" /> Rank

Rank order

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_ShowInClient" /> ShowInClient

Show task list item in which clients (web, mobile)
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[ShowInClient\_String](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_ShowInClient_String)

### <a id="SuperOffice_WebApi_Data_TaskMenu_ShowInClient_String" /> ShowInClient\_String

Show task list item in which clients (web, mobile)
Raw string enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[ShowInClient](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_ShowInClient)

### <a id="SuperOffice_WebApi_Data_TaskMenu_TableName" /> TableName

The name of entity that this task item can be used at

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_TaskMenuId" /> TaskMenuId

Primary key

```csharp theme={null}
public virtual int TaskMenuId { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_TaskType" /> TaskType

Type of task item Url, SoProtocol or CRMScript.
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[TaskType\_String](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_TaskType_String)

### <a id="SuperOffice_WebApi_Data_TaskMenu_TaskType_String" /> TaskType\_String

Type of task item Url, SoProtocol or CRMScript.
Raw string enum value.

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

#### Property Value

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

#### See Also

[TaskMenu](SuperOffice.WebApi.Data.TaskMenu.md).[TaskType](SuperOffice.WebApi.Data.TaskMenu.md#SuperOffice_WebApi_Data_TaskMenu_TaskType)

### <a id="SuperOffice_WebApi_Data_TaskMenu_Tooltip" /> Tooltip

Tooltip or other description

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_TaskMenu_UrlOrSoprotocol" /> UrlOrSoprotocol

The url or soprotocol

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Data.TaskListItemType](/en/api/reference/webapi/SuperOffice.WebApi.Data.TaskListItemType.md)
- [SuperOffice.WebApi.Data.ShowTaskItemInClient](/en/api/reference/webapi/SuperOffice.WebApi.Data.ShowTaskItemInClient.md)
- [SuperOffice.WebApi.Agents.IConfigurationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IConfigurationAgent.md)
- [SuperOffice.WebApi.Agents.ConfigurationAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ConfigurationAgent.md)