New to Telerik UI for WPFStart a free 30-day trial

Break

Class

Represents a break element in RadDocument content.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

C#
public sealed class Break : Span

Inheritance: objectDocumentElementInlineSpanBreak

Inherited Members Span.FontFamilyPropertySpan.ThemeFontFamilyPropertySpan.FontStylePropertySpan.FontWeightPropertySpan.FontSizePropertySpan.ForeColorPropertySpan.ThemeForeColorPropertySpan.ThemeForeColorShadePropertySpan.ThemeForeColorTintPropertySpan.UnderlineColorPropertySpan.ThemeUnderlineColorPropertySpan.ThemeUnderlineColorShadePropertySpan.ThemeUnderlineColorTintPropertySpan.HighlightColorPropertySpan.BaselineAlignmentPropertySpan.FlowDirectionPropertySpan.StrikethroughPropertySpan.UnderlineDecorationPropertySpan.TagPropertySpan.CopyFromPositionToEndOfInline(DocumentPosition, DocumentPosition)Span.CalculateFinalFontSize()Span.AssociateBoxWithANewSpan(Span, SpanLayoutBox)Span.TextSpan.CursorSpan.UnderlineSpan.FontFamilySpan.ThemeFontFamilySpan.FontStyleSpan.FontWeightSpan.FontSizeSpan.ForeColorSpan.ThemeForeColorSpan.ThemeForeColorShadeSpan.ThemeForeColorTintSpan.UnderlineColorSpan.ThemeUnderlineColorSpan.ThemeUnderlineColorShadeSpan.ThemeUnderlineColorTintSpan.HighlightColorSpan.BaselineAlignmentSpan.FlowDirectionSpan.StrikethroughSpan.UnderlineDecorationSpan.TagInline.CopyContentFrom(DocumentElement)Inline.FieldStartInline.IsCopyableDocumentElement.GetStyleProperty(IStylePropertyDefinition)DocumentElement.GetStyleProperty(string)DocumentElement.EnumerateChildrenOfType<T>()DocumentElement.GetParentOfType<T>()DocumentElement.CopyPropertiesFrom(DocumentElement)DocumentElement.CopyPropertiesFromStyle(StyleDefinition)DocumentElement.ExtractStyleFromProperties()DocumentElement.ExtractStyleFromLocalProperties()DocumentElement.InvalidateAssociatedBoxesLayout()DocumentElement.GetAssociatedLayoutBoxes()DocumentElement.GetRootDocument()DocumentElement.GetPropertyValueSource(IStylePropertyDefinition)DocumentElement.ClearValue(IStylePropertyDefinition)DocumentElement.ChildIndexDocumentElement.HasStyleDocumentElement.StyleDocumentElement.StyleNameDocumentElement.FirstLayoutBoxDocumentElement.ParentDocumentElement.ChildrenDocumentElement.PreviousSiblingDocumentElement.NextSiblingDocumentElement.StyleChangingDocumentElement.StyleChangedDocumentElement.StylePropertyChangedDocumentElement.ParentChangingDocumentElement.ParentChangedDocumentElement.PropertyValueChanged...

Constructors

Initializes a new instance of the Break class of type LineBreak.

C#
public Break()

Initializes a new instance of the Break class.

C#
public Break(BreakType type)
Parameters:typeBreakType

The break type.

Properties

Gets the type of the break.

C#
[XamlSerializable]
public BreakType BreakType { get; set; }
Property Value:

The type of the break.

Methods

Creates a new span which is a copy of the contents between the start of the current instance and a specified end position. This method returns null when invoked for Break elements.

C#
public override Inline CopyFromStartOfInlineToEndPosition(DocumentPosition endPosition)
Parameters:endPositionDocumentPosition

The end position.

Returns:

Inline

null for Break objects.

Overrides: Span.CopyFromStartOfInlineToEndPosition(DocumentPosition)

Copies the properties from another document element to the current instance.

C#
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters:fromElementDocumentElement

From element.

Overrides: Span.CopyPropertiesFromOverride(DocumentElement)

Creates a deep copy of the element.

C#
public override DocumentElement CreateDeepCopy()
Returns:

DocumentElement

The copied element.

Overrides: DocumentElement.CreateDeepCopy()

Creates a LayoutBox for this element.

C#
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters:documentCollectionDocumentStructureCollection

The document collection.

Returns:

LayoutBox

Exceptions:

ArgumentException

Unknown break type.

Overrides: Span.CreateLayoutBox(DocumentStructureCollection)

Creates a new Break instance.

C#
protected override DocumentElement CreateNewElementInstance()
Returns:

DocumentElement

The new Break instance.

Overrides: Span.CreateNewElementInstance()

Creates a shallow copy of the element.

C#
public override DocumentElement CreateShallowCopy()
Returns:

DocumentElement

The copied element.

Overrides: DocumentElement.CreateShallowCopy()

Determines whether the element has the same style as another Span. This method always returns false when used with a Break element.

C#
public override bool HasSameStyle(Span other, bool compareFlowDirection = false, bool ignoreStyle = false)
Parameters:otherSpan

The other.

compareFlowDirectionbool

if set to true the FlowDirection is compared as well.

ignoreStylebool

if set to true the name of the style applied to the spans is not compared.

Returns:

bool

This method always returns false when used with a Break element.

Overrides: Span.HasSameStyle(Span, bool, bool)