Class
FloatingBlock

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:

cs-api-definition
public abstract class FloatingBlock : AnnotationMarkerBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectDocumentElementInlineAnnotationMarkerBaseFloatingBlock

Derived Classes: DrawingFloatingBlockFloatingUIContainer

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members AnnotationMarkerBase.AnnotationIDAnnotationMarkerBase.SkipPositionAfterAnnotationMarkerBase.IsWordSeparatorAnnotationMarkerBase.IsCopyableInline.CopyFromPositionToEndOfInline(DocumentPosition, DocumentPosition)Inline.CopyFromStartOfInlineToEndPosition(DocumentPosition)Inline.CopyContentFrom(DocumentElement)Inline.FieldStartDocumentElement.CreateNewElementInstance()DocumentElement.GetStyleProperty(IStylePropertyDefinition)DocumentElement.GetStyleProperty(string)DocumentElement.EnumerateChildrenOfType<T>()DocumentElement.GetParentOfType<T>()DocumentElement.CreateLayoutBox()DocumentElement.CopyPropertiesFrom(DocumentElement)DocumentElement.CopyPropertiesFromStyle(StyleDefinition)DocumentElement.ExtractStyleFromProperties()DocumentElement.ExtractStyleFromLocalProperties()DocumentElement.InvalidateAssociatedBoxesArrange()DocumentElement.InvalidateAssociatedBoxesMeasure()DocumentElement.InvalidateAssociatedBoxesLayout()DocumentElement.GetAssociatedLayoutBoxes()DocumentElement.GetRootDocument()DocumentElement.CreateDeepCopy()DocumentElement.CreateShallowCopy()DocumentElement.GetPropertyValueSource(IStylePropertyDefinition)DocumentElement.ClearValue(IStylePropertyDefinition)DocumentElement.OnRemoved()DocumentElement.OnStyleChanging()DocumentElement.OnStyleChanged()DocumentElement.OnStylePropertyChanged(StylePropertyChangeEventArgs)DocumentElement.OnParentChanging()DocumentElement.OnParentChanged()DocumentElement.ChildIndexDocumentElement.HasStyleDocumentElement.StyleDocumentElement.StyleNameDocumentElement.TagDocumentElement.FirstLayoutBoxDocumentElement.IsFirstLayoutBoxInitializedDocumentElement.DocumentElementsDocumentElement.ParentDocumentElement.ChildrenDocumentElement.PreviousSiblingDocumentElement.NextSiblingDocumentElement.CursorDocumentElement.StyleChangingDocumentElement.StyleChangedDocumentElement.StylePropertyChangedDocumentElement.ParentChangingDocumentElement.ParentChangedDocumentElement.PropertyValueChangedRadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

FloatingBlock()

Initializes a new instance of the FloatingBlock class.

Declaration

cs-api-definition
public FloatingBlock()

Properties

AffectsLayout

Gets a value indicating whether the block affects the layout of the document.

Declaration

cs-api-definition
public bool AffectsLayout { get; }

Property Value

bool

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

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

Property Value

bool

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

cs-api-definition
public override AnnotationMarkerDeleteBehavior BackspaceBehavior { get; }

Property Value

AnnotationMarkerDeleteBehavior

The behavior.

Overrides AnnotationMarkerBase.BackspaceBehavior

DeleteBehavior

Defines the behavior when the users try to delete the element using the Delete key.

Declaration

cs-api-definition
public override AnnotationMarkerDeleteBehavior DeleteBehavior { get; }

Property Value

AnnotationMarkerDeleteBehavior

The behavior.

Overrides AnnotationMarkerBase.DeleteBehavior

DeleteSelectedBehavior

Defines the behavior when the users try to delete the element while the latter is selected.

Declaration

cs-api-definition
public override AnnotationMarkerDeleteBehavior DeleteSelectedBehavior { get; }

Property Value

AnnotationMarkerDeleteBehavior

The delete selected behavior.

Overrides AnnotationMarkerBase.DeleteSelectedBehavior

HorizontalPosition

Gets or sets the horizontal position.

Declaration

cs-api-definition
[XamlCompositePropertySerializable]
public FloatingBlockHorizontalPosition HorizontalPosition { get; set; }

Property Value

FloatingBlockHorizontalPosition

The horizontal position.

Exceptions

ArgumentNullException

Value cannot be null.

Margin

Gets or sets the margin.

Declaration

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

Property Value

Thickness

The margin.

Exceptions

ArgumentNullException

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.

The behavior of AnnotationRangeEnd is also controlled in the same manner.

Declaration

cs-api-definition
public override bool SkipPositionBefore { get; }

Property Value

bool

true if the position before the marker will be skipped; otherwise, false.

Overrides AnnotationMarkerBase.SkipPositionBefore

TextWrap

Gets or sets the text wrap determining how the text should be positioned around the floating block.

Declaration

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

Property Value

TextWrap

The text wrap.

VerticalPosition

Gets or sets the vertical position.

Declaration

cs-api-definition
[XamlCompositePropertySerializable]
public FloatingBlockVerticalPosition VerticalPosition { get; set; }

Property Value

FloatingBlockVerticalPosition

The vertical position.

Exceptions

ArgumentNullException

Value cannot be null.

WrappingStyle

Gets or sets a value defining how the other elements can be wrapped around the floating block.

Declaration

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

Property Value

WrappingStyle

The wrapping style.

Methods

CopyContentFromOverride(DocumentElement)

Copies the content of an element into the current instance.

Declaration

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

Parameters

fromElement

DocumentElement

From element.

Overrides Inline.CopyContentFromOverride(DocumentElement)

CopyPropertiesFromOverride(DocumentElement)

Copies the properties from another element into the current instance.

Declaration

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

Parameters

fromElement

DocumentElement

From element.

Overrides AnnotationMarkerBase.CopyPropertiesFromOverride(DocumentElement)

CreateLayoutBox(DocumentStructureCollection)

Creates a layout box for the element.

Declaration

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

Parameters

documentCollection

DocumentStructureCollection

The document collection.

Returns

LayoutBox

Overrides AnnotationMarkerBase.CreateLayoutBox(DocumentStructureCollection)