New to Telerik UI for WinForms? Start a free 30-day trial

Stores a field property's literal value or a nested field whose result supplies that value.

Definition

Namespace:Telerik.WinForms.Documents.Model.Fields

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class FieldProperty

Inheritance: objectFieldProperty

Constructors

Registers this property with its owning field under the specified definition.

C#
public FieldProperty(Field owner, FieldPropertyDefinition propertyDefinition)
Parameters:ownerField

The field that owns the property.

propertyDefinitionFieldPropertyDefinition

The definition that identifies the property.

Properties

Gets the nested field that supplies this property's value, or null when the value is literal.

C#
public Field Field { get; }

Gets whether this property is backed by a nested field rather than a literal string.

C#
public bool IsNestedField { get; }

Gets the definition used to register this property with its owning field.

C#
public FieldPropertyDefinition PropertyDefinition { get; }

Methods

Copies the stored literal value and deep-copies the nested field when the source contains one. Copying from a literal source does not clear a nested field already held by this instance.

C#
public void CopyPropertiesFrom(FieldProperty other)
Parameters:otherFieldProperty

The property to copy.

Gets the literal value, or the result text produced by the nested field.

C#
public string GetValue()
Returns:

string

The property's current string value.

Replaces any literal value with a nested field and associates that field with the owner's document.

C#
public void SetValue(Field fieldValue)
Parameters:fieldValueField

The field whose result supplies this property's value.

Sets the property from a parsed field-code argument, preserving nested fields as fields and other arguments as text. A null node clears the property to an empty string.

C#
public void SetValue(IFieldArgumentNode node)
Parameters:nodeIFieldArgumentNode

The parsed field-code argument.

Replaces any nested field with a literal value.

C#
public void SetValue(string value)
Parameters:valuestring

The literal value to store.