Class
StyleReferenceField

Represents a field in a style reference that can be used to apply styles to document elements.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class StyleReferenceField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldStyleReferenceField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingField.CodeFragmentFormatField.DisplayNameFragmentFormatField.GetFragmentToDisplay()Field.GetFragmentByDisplayMode(FieldDisplayMode)Field.SetFragmentByDisplayMode(FieldDisplayMode, DocumentFragment)Field.Update()Field.CreateFragmentFromText(string)Field.GetDisplayNameFragment()Field.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.HasDisplayNameFragmentField.FieldStartField.DisplayModeField.EvaluationContextField.Document

Constructors

StyleReferenceField()

Declaration

cs-api-definition
public StyleReferenceField()

Fields

FieldType

Declaration

cs-api-definition
public static readonly string FieldType

Field Value

string

InvalidStyleNameError

Declaration

cs-api-definition
public static readonly string InvalidStyleNameError

Field Value

string

NoPrevParagraphWithSuchStyleNameError

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Prev")]
public static readonly string NoPrevParagraphWithSuchStyleNameError

Field Value

string

StyleNameProperty

Gets or sets the name of the style associated with the StyleReferenceField.

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition StyleNameProperty

Field Value

FieldPropertyDefinition

The name of the style as a string.

Properties

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition
public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

ShouldDisplayBullet

Determines whether the bullet should be displayed for the specified style reference field.

Declaration

cs-api-definition
[XamlSerializable]
public bool ShouldDisplayBullet { get; set; }

Property Value

bool

StyleName

Declaration

cs-api-definition
[XamlSerializable]
public string StyleName { get; set; }

Property Value

string

Methods

BuildCodeOverride()

Builds the field-specific parts of the code fragment, using the current CodeBuilder.

Declaration

cs-api-definition
protected override void BuildCodeOverride()

Overrides CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

cs-api-definition
public override void CopyPropertiesFrom(Field fromField)

Parameters

fromField

Field

The other field, which has to be of the same type as the current instance.

Overrides CodeBasedField.CopyPropertiesFrom(Field)

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

Declaration

cs-api-definition
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters

fieldCodeExpression

FieldCodeExpression

The field code expression.

Overrides CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

Declaration

cs-api-definition
public override Field CreateInstance()

Returns

Field

The new field instance.

Overrides Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition
protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()