Class FieldTranslatedString

The field used to store a translated string values

Inheritance
object
FieldBase
FieldTranslatedString
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class FieldTranslatedString : FieldBase

Properties

Boost

Value to prioritize search results. Set to 1 by default. Ignored if SimpleSearch not set to true.

Declaration
[JsonProperty("boost", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public double Boost { get; set; }
Property Value
double

IndexAnalyzers

Defines how the value must be analyzed for filtering by ElasticSearch. A string field can have multiple analyzers, but only one per analyzer type.
The analyzers are applied only if the Index property is set to true.

Declaration
[JsonProperty("indexAnalyzers", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AnalyzerBase> IndexAnalyzers { get; set; }
Property Value
ICollection<AnalyzerBase>

MaximumLength

The maximum string's length.

Declaration
[JsonProperty("maximumLength", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? MaximumLength { get; set; }
Property Value
int?

MinimumLength

The minimum string's length.

Declaration
[JsonProperty("minimumLength", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? MinimumLength { get; set; }
Property Value
int?

MultiLine

Defines that the field value must be displayed in a multiline component.

Declaration
[JsonProperty("multiLine", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool MultiLine { get; set; }
Property Value
bool

Pattern

Contains a regex validation pattern.

Declaration
[JsonProperty("pattern", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string Pattern { get; set; }
Property Value
string

RenderingType

Stores information on how values of this field should be rendered

Declaration
[JsonProperty("renderingType", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(StringEnumConverter))]
public StringRenderingType RenderingType { get; set; }
Property Value
StringRenderingType

RequiredMetadataLanguages

Sets the required metadata languages for the translation field. The langauge configuration limits the available metadata languages.
If Required is true, the field and all its metadata languages are required.
If Required is false, the field can be left empty, but as soon as a value is entered all required metadata languages are mandatory.

Declaration
[JsonProperty("requiredMetadataLanguages", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> RequiredMetadataLanguages { get; set; }
Property Value
ICollection<string>

SimpleSearchAnalyzers

Defines how the value must be analyzed for searches by ElasticSearch. A string field can have multiple analyzers, but only one per analyzer type.
The analyzers are applied only if the SimpleSearch property is set to true.

Declaration
[JsonProperty("simpleSearchAnalyzers", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AnalyzerBase> SimpleSearchAnalyzers { get; set; }
Property Value
ICollection<AnalyzerBase>

Template

A DotLiquid template. If set, it transforms the field in a calculated field, so that its value is calculated based on this template.

Declaration
[JsonProperty("template", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string Template { get; set; }
Property Value
string

Methods

FromJson(string)

Declaration
public static FieldTranslatedString FromJson(string data)
Parameters
string data

Returns
FieldTranslatedString

ToJson()

Declaration
public string ToJson()
Returns
string