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

# <a id="SuperOffice_WebApi_Data_FreeText" /> Class FreeText

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

Carrier object for FreeText.
Used to manage freetext search.

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

#### Inheritance

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

## Constructors

### <a id="SuperOffice_WebApi_Data_FreeText__ctor" /> FreeText()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_FreeText_AutoEnableTravelAreas" /> AutoEnableTravelAreas

Automatically enable freetext search for new travel areas

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FreeText_CountWords" /> CountWords

Count of unique search words

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FreeText_FreeTextEnabled" /> FreeTextEnabled

True if freetext search enabled

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FreeText_LastGenerated" /> LastGenerated

Last time search has been generated

```csharp theme={null}
public virtual DateTime LastGenerated { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FreeText_MultiWordOperator" /> MultiWordOperator

Starts with, contains or exact match
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[FreeText](SuperOffice.WebApi.Data.FreeText.md).[MultiWordOperator\_String](SuperOffice.WebApi.Data.FreeText.md#SuperOffice_WebApi_Data_FreeText_MultiWordOperator_String)

### <a id="SuperOffice_WebApi_Data_FreeText_MultiWordOperator_String" /> MultiWordOperator\_String

Starts with, contains or exact match
Raw string enum value.

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

#### Property Value

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

#### See Also

[FreeText](SuperOffice.WebApi.Data.FreeText.md).[MultiWordOperator](SuperOffice.WebApi.Data.FreeText.md#SuperOffice_WebApi_Data_FreeText_MultiWordOperator)

### <a id="SuperOffice_WebApi_Data_FreeText_Occurrences" /> Occurrences

Total count of search words

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_FreeText_SingleWordOperator" /> SingleWordOperator

Starts with, contains or exact match
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[FreeText](SuperOffice.WebApi.Data.FreeText.md).[SingleWordOperator\_String](SuperOffice.WebApi.Data.FreeText.md#SuperOffice_WebApi_Data_FreeText_SingleWordOperator_String)

### <a id="SuperOffice_WebApi_Data_FreeText_SingleWordOperator_String" /> SingleWordOperator\_String

Starts with, contains or exact match
Raw string enum value.

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

#### Property Value

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

#### See Also

[FreeText](SuperOffice.WebApi.Data.FreeText.md).[SingleWordOperator](SuperOffice.WebApi.Data.FreeText.md#SuperOffice_WebApi_Data_FreeText_SingleWordOperator)

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.FreeText FreetextIndexRowsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_FreetextIndexRowsRequest.md)
- [SuperOffice.WebApi.Data.FreeText GetStatusRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_GetStatusRequest.md)
- [SuperOffice.WebApi.Data.FreeText RegenerateIndexRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_RegenerateIndexRequest.md)
- [SuperOffice.WebApi.Data.FreeText SetEnabledRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_SetEnabledRequest.md)
- [SuperOffice.WebApi.Data.FreeText SetMultiWordOperatorRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_SetMultiWordOperatorRequest.md)
- [SuperOffice.WebApi.Data.FreeText SetSingleWordOperatorRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText_SetSingleWordOperatorRequest.md)