Class
Break

Represents a break element in RadDocument content.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
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

Break()

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

Declaration

cs-api-definition
public Break()

Break(BreakType)

Initializes a new instance of the Break class.

Declaration

cs-api-definition
public Break(BreakType type)

Parameters

type

BreakType

The break type.

Properties

BreakType

Gets the type of the break.

Declaration

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

Property Value

BreakType

The type of the break.

Methods

CopyFromStartOfInlineToEndPosition(DocumentPosition)

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.

Declaration

cs-api-definition
public override Inline CopyFromStartOfInlineToEndPosition(DocumentPosition endPosition)

Parameters

endPosition

DocumentPosition

The end position.

Returns

Inline

null for Break objects.

Overrides Span.CopyFromStartOfInlineToEndPosition(DocumentPosition)

CopyPropertiesFromOverride(DocumentElement)

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

Declaration

cs-api-definition
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)

Parameters

fromElement

DocumentElement

From element.

Overrides Span.CopyPropertiesFromOverride(DocumentElement)

CreateDeepCopy()

Creates a deep copy of the element.

Declaration

cs-api-definition
public override DocumentElement CreateDeepCopy()

Returns

DocumentElement

The copied element.

Overrides DocumentElement.CreateDeepCopy()

CreateLayoutBox(DocumentStructureCollection)

Creates a LayoutBox for this element.

Declaration

cs-api-definition
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)

Parameters

documentCollection

DocumentStructureCollection

The document collection.

Returns

LayoutBox

Exceptions

ArgumentException

Unknown break type.

Overrides Span.CreateLayoutBox(DocumentStructureCollection)

CreateNewElementInstance()

Creates a new Break instance.

Declaration

cs-api-definition
protected override DocumentElement CreateNewElementInstance()

Returns

DocumentElement

The new Break instance.

Overrides Span.CreateNewElementInstance()

CreateShallowCopy()

Creates a shallow copy of the element.

Declaration

cs-api-definition
public override DocumentElement CreateShallowCopy()

Returns

DocumentElement

The copied element.

Overrides DocumentElement.CreateShallowCopy()

HasSameStyle(Span, bool, bool)

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

Declaration

cs-api-definition
public override bool HasSameStyle(Span other, bool compareFlowDirection = false, bool ignoreStyle = false)

Parameters

other

Span

The other.

compareFlowDirection

bool

if set to true the FlowDirection is compared as well.

ignoreStyle

bool

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)