Class SpanProperties

Represents the properties associated with a span element in a document, including formatting and styling.

Inheritance
System.Object
DocumentElementPropertiesBase
SpanProperties
Inherited Members
Namespace: Telerik.Windows.Documents.Model.Styles
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class SpanProperties : DocumentElementPropertiesBase, IElementWithStyle

Constructors

SpanProperties()

Declaration
public SpanProperties()

SpanProperties(DocumentElement)

Declaration
public SpanProperties(DocumentElement owner)
Parameters
DocumentElement owner

SpanProperties(StyleDefinition)

Declaration
public SpanProperties(StyleDefinition owner)
Parameters
StyleDefinition owner

Properties

BaselineAlignment

Gets or sets the baseline alignment of the span element. This property determines how the text within the span aligns with respect to the baseline.

Declaration
[XamlSerializable]
public BaselineAlignment BaselineAlignment { get; set; }
Property Value
BaselineAlignment

Gets or sets a value representing the baseline alignment.

FlowDirection

Gets or sets the flow direction of the span properties.

Declaration
[XamlSerializable]
public FlowDirection FlowDirection { get; set; }
Property Value
System.Windows.FlowDirection

A value that specifies the flow direction, which can influence the layout and rendering of text within the span.

FontFamily

Gets or sets the font family for the span properties.

Declaration
[XamlSerializable]
public FontFamily FontFamily { get; set; }
Property Value
System.Windows.Media.FontFamily

A string representing the font family name.

FontSize

Gets or sets the size of the font for the span properties.

Declaration
[XamlSerializable]
public double FontSize { get; set; }
Property Value
System.Double

A System.Double representing the size of the font.

FontStyle

Gets or sets the font style of the span properties.

Declaration
[XamlSerializable]
public FontStyle FontStyle { get; set; }
Property Value
System.Windows.FontStyle

A value of the FontStyle enumeration that specifies the font style applied to the text within the span.

FontWeight

Gets or sets the weight of the font used in the span properties.

Declaration
[XamlSerializable]
public FontWeight FontWeight { get; set; }
Property Value
System.Windows.FontWeight

A value of type FontWeight that specifies the font weight.

ForeColor

Gets or sets the foreground color of the span properties.

Declaration
[XamlSerializable]
public Color ForeColor { get; set; }
Property Value
System.Windows.Media.Color

The color of the foreground as a System.Windows.Media.Color object.

HighlightColor

Gets or sets the highlight color of the span properties.

Declaration
[XamlSerializable]
public Color HighlightColor { get; set; }
Property Value
System.Windows.Media.Color

The highlight color applied to the span. This property allows for the customization of the span's background color to enhance text visibility.

ParagraphSymbolStyleName

Gets or sets the style name for the paragraph symbol in the SpanProperties.

Declaration
[XamlSerializable("")]
public string ParagraphSymbolStyleName { get; set; }
Property Value
System.String

A string representing the style name for the paragraph symbol.

Strikethrough

Gets or sets a value indicating whether the text in the span is displayed with a strikethrough effect.

Declaration
[XamlSerializable]
public bool Strikethrough { get; set; }
Property Value
System.Boolean

A boolean value where true indicates that the text has a strikethrough, and false indicates it does not.

Tag

Gets or sets the tag associated with the SpanProperties.

Declaration
[XamlSerializable("")]
public string Tag { get; set; }
Property Value
System.String

A string representing the tag for the SpanProperties. This tag can be used to identify or categorize the span in a document.

ThemeFontFamily

Gets or sets the theme font family for the span properties.

Declaration
[XamlSerializable]
public ThemeFontsEnum ThemeFontFamily { get; set; }
Property Value
ThemeFontsEnum

The theme font family associated with the span.

ThemeForeColor

Gets or sets the theme foreground color of the span properties.

Declaration
[XamlSerializable]
public ThemeColorsEnum ThemeForeColor { get; set; }
Property Value
ThemeColorsEnum

The theme foreground color that is applied to the span.

ThemeForeColorShade

Gets or sets the shade of the theme foreground color for the SpanProperties.

Declaration
[XamlSerializable]
public string ThemeForeColorShade { get; set; }
Property Value
System.String

A value representing the shade of the theme foreground color. This property allows for customization of the foreground color implementation in document styles.

ThemeForeColorTint

Gets or sets the tint of the theme foreground color for the span properties.

Declaration
[XamlSerializable]
public string ThemeForeColorTint { get; set; }
Property Value
System.String

A double value representing the tint of the theme foreground color. A value of 0 indicates no tint, while values greater than 0 apply a tint effect.

ThemeUnderlineColor

Gets or sets the theme color applied to the underline of the text within the span properties.

Declaration
[XamlSerializable]
public ThemeColorsEnum ThemeUnderlineColor { get; set; }
Property Value
ThemeColorsEnum

A System.Windows.Media.Color representing the theme underline color. Returns the current theme underline color or a default value if none is set.

ThemeUnderlineColorShade

Gets or sets the shade of the underline color for the span properties.

Declaration
[XamlSerializable]
public string ThemeUnderlineColorShade { get; set; }
Property Value
System.String

A color shade that represents the underline color for the text in the span.

ThemeUnderlineColorTint

Gets or sets the tint of the underline color for the span properties.

Declaration
[XamlSerializable]
public string ThemeUnderlineColorTint { get; set; }
Property Value
System.String

A float representing the tint of the underline color. The tint modifies the base color's intensity, with values ranging from -1 to 1.

UnderlineColor

Gets or sets the color of the underline for the span properties.

Declaration
[XamlSerializable]
public Color UnderlineColor { get; set; }
Property Value
System.Windows.Media.Color

A System.Windows.Media.Color value representing the color of the underline.

UnderlineDecoration

Gets or sets the underline decoration for the text span properties.

Declaration
[XamlSerializable]
public IUnderlineUIDecorationProvider UnderlineDecoration { get; set; }
Property Value
IUnderlineUIDecorationProvider

Methods

CreateInstance()

Declaration
protected override DocumentElementPropertiesBase CreateInstance()
Returns
DocumentElementPropertiesBase

Overrides

InitProperties()

Declaration
protected override void InitProperties()
Overrides

ValidateStyleType(StyleDefinition)

Declaration
protected override void ValidateStyleType(StyleDefinition value)
Parameters
StyleDefinition value

Overrides

Extension Methods