Class Break

Represents a break element in RadDocument content.

Inheritance
System.Object
DocumentElement
Inline
Span
Break
Inherited Members
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Documents.dll

Syntax

public sealed class Break : Span

Constructors

Break()

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

Declaration
public Break()

Break(BreakType)

Initializes a new instance of the Break class.

Declaration
public Break(BreakType type)
Parameters
BreakType type

The break type.

Properties

BreakType

Gets the type of the break.

Declaration
[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
public override Inline CopyFromStartOfInlineToEndPosition(DocumentPosition endPosition)
Parameters
DocumentPosition endPosition

The end position.
Returns
Inline

null for Break objects.
Overrides

CopyPropertiesFromOverride(DocumentElement)

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

Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters
DocumentElement fromElement

From element.
Overrides

CreateDeepCopy()

Creates a deep copy of the element.

Declaration
public override DocumentElement CreateDeepCopy()
Returns
DocumentElement

The copied element.
Overrides

CreateLayoutBox(DocumentStructureCollection)

Creates a LayoutBox for this element.

Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
DocumentStructureCollection documentCollection

The document collection.
Returns
LayoutBox

Overrides
Exceptions
System.ArgumentException

Unknown break type.

CreateNewElementInstance()

Creates a new Break instance.

Declaration
protected override DocumentElement CreateNewElementInstance()
Returns
DocumentElement

The new Break instance.
Overrides

CreateShallowCopy()

Creates a shallow copy of the element.

Declaration
public override DocumentElement CreateShallowCopy()
Returns
DocumentElement

The copied element.
Overrides

HasSameStyle(Span, Boolean, Boolean)

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

Declaration
public override bool HasSameStyle(Span other, bool compareFlowDirection = false, bool ignoreStyle = false)
Parameters
Span other

The other.
System.Boolean compareFlowDirection

if set to true the FlowDirection is compared as well.
System.Boolean ignoreStyle

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

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

Extension Methods

See Also