ClassDocumentElement
An abstract class representing a document element.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public abstract class DocumentElement
Inheritance: objectDocumentElement
Derived Classes:
Constructors
DocumentElement()
Initializes a new instance of the DocumentElement class.
Declaration
protected DocumentElement()
Properties
ChildIndex
Gets the index of the element inside its parent structure.
Children
Gets the children.
Declaration
public DocumentElementCollection Children { get; }
Property Value
The children.
Cursor
Gets or sets the cursor image used when the mouse pointer is over the document element.
Declaration
public virtual Cursor Cursor { get; set; }
Property Value
Cursor
The cursor.
DocumentElements
Gets the elements representing the children of this document element.
Declaration
protected DocumentElementCollection DocumentElements { get; }
Property Value
The document elements.
FirstLayoutBox
Represents the first LayoutBox responsible for showing the element.
Declaration
public LayoutBox FirstLayoutBox { get; }
Property Value
The first layout box.
HasStyle
Gets a value indicating whether this instance has style.
Declaration
public bool HasStyle { get; }
Property Value
true if this instance has style; otherwise, false.
IsFirstLayoutBoxInitialized
Gets a value indicating whether the FirstLayoutBox is initialized.
Declaration
protected bool IsFirstLayoutBoxInitialized { get; }
Property Value
true if this instance is first layout box initialized; otherwise, false.
NextSibling
Gets the next sibling.
Declaration
public DocumentElement NextSibling { get; }
Property Value
The next sibling.
Parent
Gets the parent.
Declaration
public DocumentElement Parent { get; }
Property Value
The parent.
PreviousSibling
Gets the previous sibling.
Declaration
public DocumentElement PreviousSibling { get; }
Property Value
The previous sibling.
Style
Gets or sets the style of the document element.
Declaration
public virtual StyleDefinition Style { get; set; }
Property Value
The style.
StyleName
Gets or sets the name of the style.
Declaration
[XamlSerializable("")]
public string StyleName { get; set; }
Property Value
The name of the style.
Tag
String property that allows developers to attach custom data to the DocumentElement. The value of this property will be copied to DocumentElements created out of this DocumentElement during editing.
Declaration
[XamlSerializable("")]
public virtual string Tag { get; set; }
Property Value
Methods
ClearValue(IStylePropertyDefinition)
Clears the value of a style property.
Declaration
public void ClearValue(IStylePropertyDefinition propertyDefinition)
Parameters
propertyDefinition
The property definition.
CopyPropertiesFrom(DocumentElement)
Copies the properties from another document element.
Declaration
public void CopyPropertiesFrom(DocumentElement fromElement)
Parameters
fromElement
The element to copy the properties from.
Exceptions
fromElement must not be null.
Cannot copy properties to element itself.
CopyPropertiesFromOverride(DocumentElement)
Copies the properties from another document element to the current instance.
Declaration
protected abstract void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters
fromElement
The DocumentElement to copy the properties from.
CopyPropertiesFromStyle(StyleDefinition)
Copies the properties from a specified style.
Declaration
public void CopyPropertiesFromStyle(StyleDefinition style)
Parameters
style
The style to copy the properties from.
CreateDeepCopy()
Creates a deep copy of the element.
Declaration
public virtual DocumentElement CreateDeepCopy()
Returns
The copied element.
CreateLayoutBox()
Creates a LayoutBox for the document element.
CreateLayoutBox(DocumentStructureCollection)
Creates a LayoutBox for the element.
Declaration
public abstract LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
documentCollection
The document collection.
Returns
CreateNewElementInstance()
Creates a new instance of this element.
Declaration
protected abstract DocumentElement CreateNewElementInstance()
Returns
The new instance.
CreateShallowCopy()
Creates a shallow copy of the element.
Declaration
public virtual DocumentElement CreateShallowCopy()
Returns
The copied element.
EnumerateChildrenOfType<T>()
Iterates through the children of the document element.
Declaration
public IEnumerable<T> EnumerateChildrenOfType<T>() where T : DocumentElement
Returns
IEnumerable<T>
A collection of all the child elements of the specified type.
ExtractStyleFromLocalProperties()
Extracts a style from the local properties of the element.
Declaration
public StyleDefinition ExtractStyleFromLocalProperties()
Returns
A StyleDefinition instance created from the element's local properties.
ExtractStyleFromProperties()
Extracts a style from the style properties of the element.
Declaration
public StyleDefinition ExtractStyleFromProperties()
Returns
A StyleDefinition instance created from the element's style properties.
GetAssociatedLayoutBoxes()
Gets the LayoutBoxes associated to the element.
Declaration
public IEnumerable<LayoutBox> GetAssociatedLayoutBoxes()
Returns
Collection of the layout boxes associated to the element.
GetParentOfType<T>()
Iterates through the parent elements of the document element and returns the first occurence of a parent of the specified type.
Declaration
public T GetParentOfType<T>() where T : DocumentElement
Returns
T
The first parent of the specified type, or null if the element doesn't have parent.
GetPropertyValueSource(IStylePropertyDefinition)
Gets the source of the value of a specified property.
Declaration
public RadValueSource GetPropertyValueSource(IStylePropertyDefinition propertyDefinition)
Parameters
propertyDefinition
The property definition.
Returns
A RadValueSource representing the source of the value.
GetRootDocument()
Gets the RadDocument instance associated to the element.
GetStyleProperty(IStylePropertyDefinition)
Gets a style property from a specified definition.
Declaration
public StylePropertyBase GetStyleProperty(IStylePropertyDefinition propertyDefinition)
Parameters
propertyDefinition
The property definition.
Returns
The style property.
GetStyleProperty(string)
Gets a style property by name.
Declaration
public StylePropertyBase GetStyleProperty(string propertyName)
Parameters
propertyName
The name of the property.
Returns
The style property.
InvalidateAssociatedBoxesArrange()
Invalidates the arrange of the layout boxes associated to this element.
Declaration
protected void InvalidateAssociatedBoxesArrange()
InvalidateAssociatedBoxesLayout()
Invalidates the layout of the layout boxes associated to this element.
Declaration
public void InvalidateAssociatedBoxesLayout()
InvalidateAssociatedBoxesMeasure()
Invalidates the measure of the layout boxes associated to this element.
Declaration
protected void InvalidateAssociatedBoxesMeasure()
OnParentChanged()
Called when the parent of the element has been changed.
Declaration
protected virtual void OnParentChanged()
OnParentChanging()
Called when the parent of the element is changing.
Declaration
protected virtual void OnParentChanging()
OnRemoved()
Called when a DocumentElement is removed.
Declaration
protected virtual void OnRemoved()
OnStyleChanged()
Called after the style of a document element has been changed.
Declaration
protected virtual void OnStyleChanged()
OnStyleChanging()
Called before the style of a document element changes.
Declaration
protected virtual void OnStyleChanging()
OnStylePropertyChanged(StylePropertyChangeEventArgs)
Declaration
protected virtual void OnStylePropertyChanged(StylePropertyChangeEventArgs args)
Parameters
args
Events
ParentChanged
Occurs after changing the parent of the element.
ParentChanging
Occurs before changing the parent of the element.
PropertyValueChanged
Occurs after changing the value of a property.
Declaration
public event StylePropertyChangeEventHandler PropertyValueChanged
Event Value
StyleChanged
Called after the style of a document element has been changed.
StyleChanging
Called before the style of a document element changes.
StylePropertyChanged
Called after the style of a document element has been changed.
Declaration
public event StylePropertyChangeEventHandler StylePropertyChanged
Event Value