ClassFloatingBlock
Defines a block which can be positioned on its own line and wrapped up by the surrounding elements.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public abstract class FloatingBlock : AnnotationMarkerBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectDocumentElementInlineAnnotationMarkerBaseFloatingBlock
Derived Classes:
Implements:
Inherited Members
Constructors
FloatingBlock()
Initializes a new instance of the FloatingBlock class.
Declaration
public FloatingBlock()
Properties
AffectsLayout
Gets a value indicating whether the block affects the layout of the document.
Declaration
public bool AffectsLayout { get; }
Property Value
true if the WrappingStyle is Square or TopAndBottom; false if the WrappingStyle is BehindText or InFrontOfText.
AllowOverlap
Gets or sets a value indicating whether the block can overlap with other blocks.
Declaration
[XamlSerializable]
public bool AllowOverlap { get; set; }
Property Value
true if the block can overlap with other blocks; otherwise, false.
BackspaceBehavior
Defines the behavior when the users press the Backspace key to delete the element.
Declaration
public override AnnotationMarkerDeleteBehavior BackspaceBehavior { get; }
Property Value
AnnotationMarkerDeleteBehavior
The behavior.
Overrides
DeleteBehavior
Defines the behavior when the users try to delete the element using the Delete key.
Declaration
public override AnnotationMarkerDeleteBehavior DeleteBehavior { get; }
Property Value
AnnotationMarkerDeleteBehavior
The behavior.
Overrides
DeleteSelectedBehavior
Defines the behavior when the users try to delete the element while the latter is selected.
Declaration
public override AnnotationMarkerDeleteBehavior DeleteSelectedBehavior { get; }
Property Value
AnnotationMarkerDeleteBehavior
The delete selected behavior.
Overrides
HorizontalPosition
Gets or sets the horizontal position.
Declaration
[XamlCompositePropertySerializable]
public FloatingBlockHorizontalPosition HorizontalPosition { get; set; }
Property Value
FloatingBlockHorizontalPosition
The horizontal position.
Exceptions
Value cannot be null.
Margin
Gets or sets the margin.
Declaration
[XamlSerializable]
public Thickness Margin { get; set; }
Property Value
The margin.
Exceptions
Value cannot be null.
SkipPositionBefore
Determines if the CaretPosition will be put before or after the annotation marker.
If the value of this property is true for an AnnotationRangeStart, then if you move the caret to the annotation start and start typing,
the newly inserted text will be considered as part of the annotation. Vice versa, if it is set to false, the typed text will be inserted before the annotation.
Declaration
public override bool SkipPositionBefore { get; }
Property Value
true if the position before the marker will be skipped; otherwise, false.
Overrides
TextWrap
Gets or sets the text wrap determining how the text should be positioned around the floating block.
Declaration
[XamlSerializable]
public TextWrap TextWrap { get; set; }
Property Value
The text wrap.
VerticalPosition
Gets or sets the vertical position.
Declaration
[XamlCompositePropertySerializable]
public FloatingBlockVerticalPosition VerticalPosition { get; set; }
Property Value
The vertical position.
Exceptions
Value cannot be null.
WrappingStyle
Gets or sets a value defining how the other elements can be wrapped around the floating block.
Declaration
[XamlSerializable]
public WrappingStyle WrappingStyle { get; set; }
Property Value
The wrapping style.
Methods
CopyContentFromOverride(DocumentElement)
Copies the content of an element into the current instance.
Declaration
protected override void CopyContentFromOverride(DocumentElement fromElement)
Parameters
fromElement
From element.
Overrides
CopyPropertiesFromOverride(DocumentElement)
Copies the properties from another element into the current instance.
Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters
fromElement
From element.
Overrides
CreateLayoutBox(DocumentStructureCollection)
Creates a layout box for the element.
Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
documentCollection
The document collection.
Returns
Overrides