Documentation

Class Run

An inline-level flow content element intended to contain a run of formatted or unformatted text.

Inheritance

System.Object

DocumentElementBase

InlineBase

Run

Inherited Members

InlineBase.Paragraph

DocumentElementBase.EnumerateChildrenOfType<T>()

DocumentElementBase.OnChildAdded(DocumentElementBase)

DocumentElementBase.OnChildRemoved(DocumentElementBase)

DocumentElementBase.Document

DocumentElementBase.Parent

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Flow.Model

Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public sealed class Run : InlineBase, IElementWithStyle, IElementWithProperties

Constructors

Run(RadFlowDocument)

Initializes a new instance of the Run class.

Declaration

public Run(RadFlowDocument document)

Parameters

RadFlowDocument document The document in which the element will be added.

Fields

BackgroundColorPropertyDefinition

Gets the background color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> BackgroundColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

BaselineAlignmentPropertyDefinition

Gets the baseline alignment property definition.

Declaration

public static readonly StylePropertyDefinition<BaselineAlignment? > BaselineAlignmentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<BaselineAlignment>>

FlowDirectionPropertyDefinition

Gets the flow direction property definition.

Declaration

public static readonly StylePropertyDefinition<FlowDirection? > FlowDirectionPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<FlowDirection>>

FontFamilyPropertyDefinition

Gets the font family property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableFontFamily> FontFamilyPropertyDefinition

Field Value

StylePropertyDefinition<ThemableFontFamily>

FontSizePropertyDefinition

Gets the font size property definition.

Declaration

public static readonly StylePropertyDefinition<double? > FontSizePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

FontStylePropertyDefinition

Gets the font style property definition.

Declaration

public static readonly StylePropertyDefinition<FontStyle? > FontStylePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Windows.FontStyle>>

FontWeightPropertyDefinition

Gets the font weight property definition.

Declaration

public static readonly StylePropertyDefinition<FontWeight? > FontWeightPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Windows.FontWeight>>

ForegroundColorPropertyDefinition

Gets the foreground color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> ForegroundColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

HighlightColorPropertyDefinition

Gets the highlight color property definition.

Declaration

public static readonly StylePropertyDefinition<Color? > HighlightColorPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Windows.Media.Color>>

ShadingPatternColorPropertyDefinition

Gets the shading pattern color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> ShadingPatternColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

ShadingPatternPropertyDefinition

Gets the shading pattern property definition.

Declaration

public static readonly StylePropertyDefinition<ShadingPattern? > ShadingPatternPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<ShadingPattern>>

StrikethroughPropertyDefinition

Gets the strikethrough property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > StrikethroughPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

UnderlineColorPropertyDefinition

Gets the underline color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> UnderlineColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

UnderlinePatternPropertyDefinition

Gets the underline pattern property definition.

Declaration

public static readonly StylePropertyDefinition<UnderlinePattern? > UnderlinePatternPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<UnderlinePattern>>

Properties

BaselineAlignment

Gets or sets the baseline alignment.

Declaration

public BaselineAlignment BaselineAlignment { get; set; }

Property Value

BaselineAlignment The default value is `Baseline`.

FlowDirection

Gets or sets the flow direction.

Declaration

public FlowDirection FlowDirection { get; set; }

Property Value

FlowDirection The default value is `LeftToRight`

FontFamily

Gets or sets the font family.

Declaration

public ThemableFontFamily FontFamily { get; set; }

Property Value

ThemableFontFamily The font family.

FontStyle

Gets or sets the font style.

Declaration

public FontStyle FontStyle { get; set; }

Property Value

System.Windows.FontStyle The default value is `Normal`.

FontWeight

Gets or sets the font weight.

Declaration

public FontWeight FontWeight { get; set; }

Property Value

System.Windows.FontWeight The default value is `Normal`.

ForegroundColor

Gets or sets the color of the foreground.

Declaration

public ThemableColor ForegroundColor { get; set; }

Property Value

ThemableColor The default value is `black`.

HighlightColor

Gets or sets the color of the highlight.

Declaration

public Color HighlightColor { get; set; }

Property Value

System.Windows.Media.Color The default value is `Transparent`.

Properties

Gets the styling properties of this element.

Declaration

public CharacterProperties Properties { get; }

Property Value

CharacterProperties The properties.

Shading

Gets the shading.

Declaration

public Shading Shading { get; }

Property Value

Shading The shading.

Strikethrough

Gets or sets the strikethrough.

Declaration

public bool Strikethrough { get; set; }

Property Value

System.Boolean The default value is `false`.

StyleId

Gets or sets the style id.

Declaration

public string StyleId { get; set; }

Property Value

System.String The style id.

Implements

IElementWithStyle.StyleId

Text

Gets or sets the text.

Declaration

public string Text { get; set; }

Property Value

System.String The text.

Underline

Gets the underline.

Declaration

public Underline Underline { get; }

Property Value

Underline The underline.

Methods

Clone()

Creates deep copy of this document element, associated to the current document.

Declaration

public Run Clone()

Returns

Run The cloned element.

Clone(RadFlowDocument)

Creates deep copy of this document element, associated to document.

Declaration

public Run Clone(RadFlowDocument document)

Parameters

RadFlowDocument document The document to which the cloned element should be associated.

Returns

Run The cloned element.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

System.String A string that represents the current object.

Overrides

System.Object.ToString()

Explicit Interface Implementations

IElementWithProperties.Properties

Gets the properties.

Declaration

DocumentElementPropertiesBase IElementWithProperties.Properties { get; }

Returns

DocumentElementPropertiesBase The properties.

Implements

IElementWithProperties.Properties

Extension Methods

EditingExtensions.GetEditorAfter(InlineBase)

EditingExtensions.GetEditorBefore(InlineBase)