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

# <a id="SuperOffice_WebApi_Data_PreferenceDescription" /> Class PreferenceDescription

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

Carrier object for PreferenceDescription.
Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.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 PreferenceDescription 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new PreferenceAgent(configuration);
var preferenceDescription = agent.GetPreferenceDescription( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_PreferenceDescription__ctor" /> PreferenceDescription()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_AccessFlags" /> AccessFlags

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[AccessFlags\_String](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_AccessFlags_String)

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_AccessFlags_String" /> AccessFlags\_String

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui
Raw string enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[AccessFlags](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_AccessFlags)

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

Description of preference, multi-language parsed

```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_PreferenceDescription_IsBuiltin" /> IsBuiltin

1 = This row populated and maintained by SuperOffice

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_Key" /> Key

Preference key name

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_MaxLevel" /> MaxLevel

Lowest allowed setting level, set by user, but not lower than sysMaxLevel
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[MaxLevel\_String](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_MaxLevel_String)

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_MaxLevel_String" /> MaxLevel\_String

Lowest allowed setting level, set by user, but not lower than sysMaxLevel
Raw string enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[MaxLevel](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_MaxLevel)

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_MaxValue" /> MaxValue

Max value (if type 1); list table ID (if type 5)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_MinLevel" /> MinLevel

The minimum (furthest away from User) level this preference can be set for

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_MinValue" /> MinValue

Min value (if type 1); list extra id (if type 5)

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

#### Property Value

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

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

Multi-language name

```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_PreferenceDescription_PrefDescId" /> PrefDescId

Primary key

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

#### Property Value

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

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

Rank field for ordering sections, and keys within sections

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_RequiredLicense" /> RequiredLicense

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_Section" /> Section

Preference section name

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_SubGroup" /> SubGroup

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_SysMaxLevel" /> SysMaxLevel

Lowest allowed setting level, set by SuperOffice
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[SysMaxLevel\_String](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_SysMaxLevel_String)

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_SysMaxLevel_String" /> SysMaxLevel\_String

Lowest allowed setting level, set by SuperOffice
Raw string enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[SysMaxLevel](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_SysMaxLevel)

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

If valueType = 5, then TableName contains the table referenced by the preference

```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_PreferenceDescription_UserDefinedListId" /> UserDefinedListId

Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_ValueType" /> ValueType

1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[ValueType\_String](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_ValueType_String)

### <a id="SuperOffice_WebApi_Data_PreferenceDescription_ValueType_String" /> ValueType\_String

1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID
Raw string enum value.

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

#### Property Value

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

#### See Also

[PreferenceDescription](SuperOffice.WebApi.Data.PreferenceDescription.md).[ValueType](SuperOffice.WebApi.Data.PreferenceDescription.md#SuperOffice_WebApi_Data_PreferenceDescription_ValueType)

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.PreferenceDescriptionLine](/en/api/reference/webapi/SuperOffice.WebApi.Data.PreferenceDescriptionLine.md)
- [SuperOffice.WebApi.Agents.PreferenceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PreferenceAgent.md)
- [SuperOffice.WebApi.Agents.IPreferenceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPreferenceAgent.md)
- [SuperOffice.WebApi.Data.Preference SaveFromSectionAndKeyRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Preference_SaveFromSectionAndKeyRequest.md)
- [Delete Preference Description](/en/api/reference/restful/rest/preferencedescription/delete-preference-description.md)
- [Get Preference Description](/en/api/reference/restful/rest/preferencedescription/get-preference-description.md)