[]
        
(Showing Draft Content)

C1.WPF.RichTextBox.Documents.C1TextElement

C1TextElement Class

An abstract class used as the base class for all elements in a C1Document.

Inheritance
C1TextElement
Namespace: C1.WPF.RichTextBox.Documents
Assembly: C1.WPF.RichTextBox.dll
Syntax
public class C1TextElement : IEnumerable<C1TextElement>, IEnumerable

Constructors

Name Description
C1TextElement()

Initializes a new C1TextElement

Fields

Name Description
BackgroundProperty

Identifies the Background style property.

BorderBrushProperty

Identifies the BorderBrush style property.

BorderThicknessProperty

Identifies the BorderThickness style property.

CornerRadiusProperty

Identifies the CornerRadius style property.

CursorProperty

Identifies the Cursor style property.

FontFamilyProperty

Identifies the FontFamily style property.

FontSizeProperty

Identifies the FontSize style property.

FontStyleProperty

Identifies the FontStyle style property.

FontWeightProperty

Identifies the FontWeight style property.

ForegroundProperty

Identifies the Foreground style property.

HeightProperty

Identifies the Height style property.

IsEditableProperty

Identifies the IsEditable style property.

LineHeightProperty

Identifies the LineHeight style property.

MarginProperty

Identifies the Margin style property.

MaxHeightProperty

Identifies the MaxHeight style property.

MaxWidthProperty

Identifies the MaxWidth style property.

MinHeightProperty

Identifies the MinHeight style property.

MinWidthProperty

Identifies the MinWidth style property.

PaddingProperty

Identifies the Padding style property.

TextDecorationsProperty

Identifies the TextDecorations style property.

TextEffectProperty

Identifies the TextEffect style property.

ToolTipProperty

Identifies the ToolTip style property.

VerticalAlignmentProperty

Identifies the VerticalAlignment style property.

VisibilityProperty

Identifies the Visibility style property.

WidthProperty

Identifies the Width style property.

Properties

Name Description
Background

Gets or sets the Brush used to fill the background of the content area.

BorderBrush

Gets or sets the Brush used to fill the border of a text element.

BorderThickness

Gets or sets the border thickness of a text element.

Children

Get all children of this C1TextElement.

ContentEnd

Gets the C1TextPointer at the end of this text element.

ContentRange

Gets the C1TextRange of this element's content.

ContentStart

Gets the C1TextPointer at the start of this text element.

CornerRadius

Gets or sets the corner radius for the border of a text element.

Cursor

Gets or sets the Cursor displayed when the mouse is over this element.

EndTag

Returns the EndTag of this C1TextElement.

FontFamily

Gets or sets the preferred font family for the content of the element.

FontSize

Gets or sets the font size for the content of the element.

FontStyle

Gets or sets the font style for the content of the element.

FontWeight

Gets or sets the font weight for the content of the element.

Foreground

Gets or sets the Brush to apply to the content of the element.

Height

Gets or sets the height of this C1TextElement.

Id

Gets or sets an identifier for this text element.

Index

Get the index of this C1TextElement in its parent Children collection.

IsCollapsed

Returns whether this element is collapsed, that is, if its Visibility, or that of one of its parents, is Collapsed.

IsEditable

Gets or sets whether the content of this element are editable in a C1RichTextBox.

IsLeaf

Returns whether this element is a leaf in the document tree.

IsRoot

Returns whether this element is the root of its tree.

LineHeight

Gets or sets a number that is multiplied by the computed height of a line to obtain the final height.

Margin

Gets or sets the margin of a text element.

MaxHeight

Gets or sets the max-height of this C1TextElement.

MaxWidth

Gets or sets the max-width of this C1TextElement.

MinHeight

Gets or sets the min-height of this C1TextElement.

MinWidth

Gets or sets the min-width of this C1TextElement.

Name

Gets or sets the name for this text element.

NextSibling

Gets the next sibling of this element, or null if this is the last child.

Padding

Gets or sets the padding of a text element.

Parent

Gets the parent of this element.

PreviousSibling

Gets the previous sibling of this element, or null if this is the first child.

Root

Returns the root element of this element's tree.

StartTag

Returns the StartTag of this C1TextElement.

Style

Returns the style values for this C1TextElement.

TextDecorations

Gets or sets a collection of text decorations to apply to the content of the element.

TextEffect

Gets or sets the Effect applied to the text of this element.

ToolTip

Gets or sets the ToolTip displayed when the mouse is over this element.

VerticalAlignment

Gets or sets a value indicating how elements are aligned in a line.

Visibility

Gets or sets the visibility of this element.

Width

Gets or sets the width of this C1TextElement.

Methods

Name Description
ClearValue(StyleProperty)

Clears the value of style property in this C1TextElement.

Clone()

Returns a deep copy of this element.

CreateNewElement()

Creates a new C1TextElement with the same type as this.

Enumerate(LogicalDirection)

Enumerates the elements in the document in the specified direction.

EnumerateSubtree()

Enumerates all elements in the sub tree where this element is root.

GetEnumerator()

Returns an enumerator that iterates through the collection.

GetParents()

Returns the list of parents from the root.

GetValue<T>(StyleProperty)

Returns the value of a style property for this C1TextElement.

Group(C1TextElement, int, int)

Groups some of this C1TextElement children, all children in the specified range are added to the new parent, and the parent is inserted at the range start.

IsValidChild(Type)

Checks whether a type is a valid child of this C1TextElement.

JoinSibling()

Joins this element with its next sibling.

OnTextChanged(C1TextChangedEventArgs)

Called when the TextChanged event needs to be fired.

OnTextChanging(C1TextChangedEventArgs)

Called when the TextChanging event needs to be fired.

Remove()

Removes the element from the document tree.

Remove(int, int)

Removes a range of children in this element.

SetValue<T>(StyleProperty, T)

Sets the value of a style property of this C1TextElement.

ShallowClone()

Returns a shallow copy of this element.

Split(int)

Splits this C1TextElement at the specified offset into two elements of the same type with the same style properties.

Split(int, bool)

Splits this C1TextElement at the specified offset into two elements of the same type with the same style properties.

UnGroup()

Ungroups this C1TextElement, that is, this C1TextElement is removed, and all its children are added to its parent.

Events

Name Description
ChildrenChanged

Fires when the children collection of this C1TextElement changes.

TextChanged

Fires after a text change occurs in the sub tree where this element is root.

TextChanging

Fires before a text change occurs in the sub tree where this element is root.