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

# NSFreeText

> Used to manage freetext search.

Used to manage freetext search.

## Constructors

### NSFreeText()

```crmscript theme={null}
NSFreeText
```

Initializes a new instance of the NSFreeText class.

## Methods

## GetAutoEnableTravelAreas()

```crmscript theme={null}
Bool GetAutoEnableTravelAreas()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Automatically enable free-text search for new travel areas.

**Example:**

```crmscript theme={null}
NSFreeText thing;
Bool autoEnableTravelAreas = thing.GetAutoEnableTravelAreas();
```

## GetCountWords()

```crmscript theme={null}
Integer GetCountWords()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Count of unique search words.

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer countWords = thing.GetCountWords();
```

## GetFreeTextEnabled()

```crmscript theme={null}
Bool GetFreeTextEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if free-text search enabled.

**Example:**

```crmscript theme={null}
NSFreeText thing;
Bool freeTextEnabled = thing.GetFreeTextEnabled();
```

## GetLastGenerated()

```crmscript theme={null}
DateTime GetLastGenerated()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Last time search has been generated.

**Example:**

```crmscript theme={null}
NSFreeText thing;
DateTime lastGenerated = thing.GetLastGenerated();
```

## GetMultiWordOperator()

```crmscript theme={null}
Integer GetMultiWordOperator()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Starts with, contains or exact match. See \<xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer multiWordOperator = thing.GetMultiWordOperator();
```

## GetOccurrences()

```crmscript theme={null}
Integer GetOccurrences()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Total count of search words.

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer occurrences = thing.GetOccurrences();
```

## GetSingleWordOperator()

```crmscript theme={null}
Integer GetSingleWordOperator()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Starts with, contains or exact match. See \<xref href="CRMScript.NetServer.FreeTextOperator" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer singleWordOperator = thing.GetSingleWordOperator();
```

## SetAutoEnableTravelAreas(Bool)

```crmscript theme={null}
Void SetAutoEnableTravelAreas(Bool autoEnableTravelAreas)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Bool autoEnableTravelAreas;
thing.SetAutoEnableTravelAreas(autoEnableTravelAreas);
```

## SetCountWords(Integer)

```crmscript theme={null}
Void SetCountWords(Integer countWords)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer countWords;
thing.SetCountWords(countWords);
```

## SetFreeTextEnabled(Bool)

```crmscript theme={null}
Void SetFreeTextEnabled(Bool freeTextEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Bool freeTextEnabled;
thing.SetFreeTextEnabled(freeTextEnabled);
```

## SetLastGenerated(DateTime)

```crmscript theme={null}
Void SetLastGenerated(DateTime lastGenerated)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
DateTime lastGenerated;
thing.SetLastGenerated(lastGenerated);
```

## SetMultiWordOperator(Integer)

```crmscript theme={null}
Void SetMultiWordOperator(Integer multiWordOperator)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer multiWordOperator;
thing.SetMultiWordOperator(multiWordOperator);
```

## SetOccurrences(Integer)

```crmscript theme={null}
Void SetOccurrences(Integer occurrences)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer occurrences;
thing.SetOccurrences(occurrences);
```

## SetSingleWordOperator(Integer)

```crmscript theme={null}
Void SetSingleWordOperator(Integer singleWordOperator)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeText thing;
Integer singleWordOperator;
thing.SetSingleWordOperator(singleWordOperator);
```


## Related topics

- [NSFreeTextAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSFreeTextAgent.md)
- [Configure free-text search](/en/search-options/admin/configure-free-text-search.md)
- [Enum FreeTextOperator](/en/automation/crmscript/reference/CRMScript.NetServer.FreeTextOperator.md)
- [SuperOffice.WebApi.Data.FreeText](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText.md)
- [SuperOffice.WebApi.Agents.FreeTextAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.FreeTextAgent.md)
- [SuperOffice.WebApi.Agents.IFreeTextAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IFreeTextAgent.md)