TX Text Control .NET Server

Remove Method

Method|Introduced in 24.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages

Also in: TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Removes a document property from the dictionary.

Syntax

public void Remove(string name);

Public Sub Remove(name As String)

Parameters

Parameter	Description
name	Specifies the name of the document property to remove.

Examples

The following example removes obsolete department metadata before export.

UserDefinedPropertyDictionary properties = new();
properties.Add("ReviewStatus", "Approved");
properties.Add("Department", "Finance");
if (properties.Contains("Department"))
{
    properties.Remove("Department");
}

Dim properties As New UserDefinedPropertyDictionary()
properties.Add("ReviewStatus", "Approved")
properties.Add("Department", "Finance")
If properties.Contains("Department") Then
    properties.Remove("Department")
End If