Class
DocumentElementPropertiesBase

Represents the base class for document element properties in the Telerik document model.

Definition

Namespace:Telerik.Windows.Documents.Model.Styles

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public abstract class DocumentElementPropertiesBase : IElementWithStyle

Inheritance: objectDocumentElementPropertiesBase

Derived Classes: DocumentPropertiesEmptyDocumentElementPropertiesParagraphPropertiesSectionPropertiesSpanPropertiesTableCellPropertiesTablePropertiesTableRowProperties

Implements: IElementWithStyle

Constructors

DocumentElementPropertiesBase(DocumentElement)

Declaration

cs-api-definition
public DocumentElementPropertiesBase(DocumentElement owner)

Parameters

owner

DocumentElement

DocumentElementPropertiesBase(StyleDefinition)

Declaration

cs-api-definition
public DocumentElementPropertiesBase(StyleDefinition owner)

Parameters

owner

StyleDefinition

Properties

HasRevisions

Gets a value indicating whether the document element has revisions.

Declaration

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

Property Value

bool

OriginalProperties

Gets the original properties of the document element.

Declaration

cs-api-definition
public DocumentElementPropertiesBase OriginalProperties { get; }

Property Value

DocumentElementPropertiesBase

OriginalStyleName

Gets or sets the original style name of the document element.

Declaration

cs-api-definition
[XamlSerializable("")]
public string OriginalStyleName { get; set; }

Property Value

string

A string representing the original style name.

RevisionInfo

Gets or sets the revision information for the document element.

Declaration

cs-api-definition
public RevisionInfo RevisionInfo { get; set; }

Property Value

RevisionInfo

A RevisionInfo object that contains details about the revision state of the document element.

Style

Gets or sets the style applied to the document element.

Declaration

cs-api-definition
public virtual StyleDefinition Style { get; set; }

Property Value

StyleDefinition

The style applied to the document element represented by this instance.

Implements IElementWithStyle.Style

StyleName

Gets or sets the style name for the document element.

Declaration

cs-api-definition
public string StyleName { get; set; }

Property Value

string

A string that represents the name of the style applied to the document element.

StyleProperties

Gets or sets the style properties for the document element.

Declaration

cs-api-definition
public IEnumerable<StylePropertyBase> StyleProperties { get; }

Property Value

IEnumerable<StylePropertyBase>

The style properties associated with the document element.

Methods

ClearProperties()

Clears all properties from the document element.

Declaration

cs-api-definition
public void ClearProperties()

CopyPropertiesFrom(DocumentElementPropertiesBase)

Copies properties from the specified DocumentElementPropertiesBase object to the current instance.

Declaration

cs-api-definition
public virtual void CopyPropertiesFrom(DocumentElementPropertiesBase fromProperties)

Parameters

fromProperties

DocumentElementPropertiesBase

The DocumentElementPropertiesBase object from which to copy properties.

CreateInstance()

Declaration

cs-api-definition
protected abstract DocumentElementPropertiesBase CreateInstance()

Returns

DocumentElementPropertiesBase

GetStyleProperty(IStylePropertyDefinition)

Retrieves the value of a specified style property from the document element.

Declaration

cs-api-definition
public StylePropertyBase GetStyleProperty(IStylePropertyDefinition propertyDefinition)

Parameters

propertyDefinition

IStylePropertyDefinition

The definition of the style property to retrieve.

Returns

StylePropertyBase

The value of the specified style property, if it exists; otherwise, null.

GetStyleProperty(string)

Retrieves the value of the specified style property.

Declaration

cs-api-definition
public StylePropertyBase GetStyleProperty(string propertyName)

Parameters

propertyName

string

The name of the style property to retrieve.

Returns

StylePropertyBase

The value of the style property identified by propertyName.

InitProperties()

Declaration

cs-api-definition
protected abstract void InitProperties()

MergePropertiesWith(DocumentElementPropertiesBase)

Merges the properties of the current DocumentElementPropertiesBase instance with the properties of another DocumentElementPropertiesBase instance.

Declaration

cs-api-definition
public void MergePropertiesWith(DocumentElementPropertiesBase propertiesToMergeWith)

Parameters

propertiesToMergeWith

DocumentElementPropertiesBase

The DocumentElementPropertiesBase instance whose properties will be merged into the current instance.

OnStyleChanged()

Declaration

cs-api-definition
protected virtual void OnStyleChanged()

OnStyleChanging()

Declaration

cs-api-definition
protected virtual void OnStyleChanging()

OnStylePropertyChangedOverride(StylePropertyChangeEventArgs)

Declaration

cs-api-definition
protected virtual void OnStylePropertyChangedOverride(StylePropertyChangeEventArgs args)

Parameters

args

StylePropertyChangeEventArgs

ToString()

Returns a string representation of the current instance of the DocumentElementPropertiesBase class.

Declaration

cs-api-definition
public override string ToString()

Returns

string

A string that represents the current object.

Overrides object.ToString()

ValidateStyleType(StyleDefinition)

Declaration

cs-api-definition
protected virtual void ValidateStyleType(StyleDefinition value)

Parameters

value

StyleDefinition