# DocumentSettings.UserDefinedDocumentProperties Property

> Gets or sets a dictionary with all user-defined document properties contained in the current document. The property's value is an object of the type UserDefinedPropertyDictionary or null, if the current document does not contain any user-defined property.

- **Product:** TX Text Control .NET Server
- **Section:** Reference
- **Kind:** Property
- **Introduced:** 29.0
- **Namespace:** `TXTextControl`
- **Package:** `TXTextControl.TextControl.Core.SDK` (assembly `TXTextControl.Core.dll`, from the private NuGet feed or Text Control Offline Packages)
- **Package:** `TXTextControl.TextControl.ASP.SDK` (assembly `TXTextControl.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXTextControl.dll` from the setup
- **Path:** TX Text Control .NET Server > Reference > TXTextControl > DocumentSettings.UserDefinedDocumentProperties Property
- **488 words**
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/documentsettings/userdefineddocumentproperties-property/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/documentsettings/userdefineddocumentproperties-property/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/documentsettings/userdefineddocumentproperties-property/llms-full.txt

---

### Description

Gets or sets a dictionary with all user-defined document properties contained in the current document. The property's value is an object of the type [UserDefinedPropertyDictionary](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/userdefinedpropertydictionary/llms-full.txt) or null, if the current document does not contain any user-defined property.

### Syntax

```csharp
public UserDefinedPropertyDictionary UserDefinedDocumentProperties { get; set; }
```

```vbnet
Public Property UserDefinedDocumentProperties As UserDefinedPropertyDictionary
```

### Examples

The following example attaches review metadata as user-defined document properties.

```csharp
UserDefinedPropertyDictionary properties = new();
properties.Add("ReviewStatus", "Approved");
properties.Add("Department", "Finance");

DocumentSettings documentSettings = textControl.DocumentSettings;
documentSettings.UserDefinedDocumentProperties = properties;
```

```vbnet
Dim properties As New UserDefinedPropertyDictionary()
properties.Add("ReviewStatus", "Approved")
properties.Add("Department", "Finance")

Dim documentSettings As DocumentSettings = textControl.DocumentSettings
documentSettings.UserDefinedDocumentProperties = properties
```

---

## Nearby

- **Previous:** [DocumentSettings.EmbeddedFiles Property](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/documentsettings/embeddedfiles-property/llms-full.txt)
- **Next:** [DocumentTarget Class](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/txtextcontrol/documenttarget/llms-full.txt)
