Class DataProviderBase

Represents a wrapper of ITextBasedDocumentFormatProvider allowing the latter to be used in data binding scenarios.

Inheritance

System.Object

DataProviderBase

HtmlDataProvider

RtfDataProvider

TxtDataProvider

XamlDataProvider

Namespace: Telerik.Windows.Documents.FormatProviders

Assembly: Telerik.Windows.Documents.dll

Syntax

public class DataProviderBase : FrameworkElement

Constructors

DataProviderBase(ITextBasedDocumentFormatProvider, DependencyProperty)

Initializes a new instance of the DataProviderBase class.

Declaration

public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, DependencyProperty stringProperty)

Parameters

ITextBasedDocumentFormatProvider formatProvider The format provider.

System.Windows.DependencyProperty stringProperty The string property.

DataProviderBase(ITextBasedDocumentFormatProvider, FrameworkElement, DependencyProperty)

Initializes a new instance of the DataProviderBase class.

Declaration

public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, FrameworkElement propertyOwner, DependencyProperty stringProperty)

Parameters

ITextBasedDocumentFormatProvider formatProvider The format provider.

System.Windows.FrameworkElement propertyOwner The property owner.

System.Windows.DependencyProperty stringProperty The string property.

Fields

FormatProviderProperty

The format provider property.

Declaration

public static readonly DependencyProperty FormatProviderProperty

Field Value

System.Windows.DependencyProperty

RichTextBoxProperty

The rich text box property.

Declaration

public static readonly DependencyProperty RichTextBoxProperty

Field Value

System.Windows.DependencyProperty

UpdateSourceTriggerProperty

The update source trigger property.

Declaration

public static readonly DependencyProperty UpdateSourceTriggerProperty

Field Value

System.Windows.DependencyProperty

Properties

FormatProvider

Gets or sets the ITextBasedDocumentFormatProvider that is used when converting the document.

Declaration

public ITextBasedDocumentFormatProvider FormatProvider { get; set; }

Property Value

ITextBasedDocumentFormatProvider

RichTextBox

Gets or sets the RadRichTextBox this DataProvider is attached to.

Declaration

public RadRichTextBox RichTextBox { get; set; }

Property Value

RadRichTextBox

String

Gets or sets the string representing the document.

Declaration

protected string String { get; set; }

Property Value

System.String The string.

UpdateSourceTrigger

Gets or sets the update source trigger.

Declaration

public DataProviderUpdateSourceTrigger UpdateSourceTrigger { get; set; }

Property Value

DataProviderUpdateSourceTrigger The update source trigger.

Methods

Bind(RadRichTextBox)

Binds the specified RadRichTextBox.

Declaration

protected virtual void Bind(RadRichTextBox radRichTextBox)

Parameters

RadRichTextBox radRichTextBox The RadRichTextBox.

CreateStringProperty(String)

Creates a custom string property.

Declaration

protected static DependencyProperty CreateStringProperty(string name)

Parameters

System.String name The name.

Returns

System.Windows.DependencyProperty

OnAttachedDataProviderPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called after changing the attached data provider.

Declaration

public static void OnAttachedDataProviderPropertyChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)

Parameters

System.Windows.DependencyObject dependencyObject The dependency object.

System.Windows.DependencyPropertyChangedEventArgs e The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnImportException(DataProviderImportExceptionEventArgs)

Raises the ImportException event.

Declaration

protected virtual void OnImportException(DataProviderImportExceptionEventArgs args)

Parameters

DataProviderImportExceptionEventArgs args The DataProviderImportExceptionEventArgs instance containing the event data.

OnSetupDocument(RadDocument)

Called when the data provider creates a new document.

Declaration

protected virtual void OnSetupDocument(RadDocument document)

Parameters

RadDocument document The document.

OnStringChanged()

Called when the string associated to the provider is changed.

Declaration

protected virtual void OnStringChanged()

SetValueRespectingOneWayBindings(String)

Sets the value respecting one way bindings.

Declaration

protected void SetValueRespectingOneWayBindings(string value)

Parameters

System.String value The value.

StringPropertyChangedCallback(DependencyObject, DependencyPropertyChangedEventArgs)

A callback invoked when the associated string is changed.

Declaration

protected static void StringPropertyChangedCallback(DependencyObject sender, DependencyPropertyChangedEventArgs e)

Parameters

System.Windows.DependencyObject sender The sender.

System.Windows.DependencyPropertyChangedEventArgs e The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

Unbind(RadRichTextBox)

Unbinds the specified RadRichTextBox instance.

Declaration

protected virtual void Unbind(RadRichTextBox radRichTextBox)

Parameters

RadRichTextBox radRichTextBox The RadRichTextBox.

UpdateAttachedDataProvider(DependencyObject, Func<RadRichTextBox, DataProviderBase>, Func<DependencyObject, DataProviderBase>, Action<DependencyObject, DataProviderBase>, DependencyProperty, Object)

Updates the attached data provider.

Declaration

public static void UpdateAttachedDataProvider(DependencyObject dependencyObject, Func<RadRichTextBox, DataProviderBase> formatProviderFactory, Func<DependencyObject, DataProviderBase> getAttachedDataProvider, Action<DependencyObject, DataProviderBase> setAttachedDataProvider, DependencyProperty attachedDataProviderProperty, object newValue)

Parameters

System.Windows.DependencyObject dependencyObject The dependency object.

System.Func<RadRichTextBox, DataProviderBase> formatProviderFactory The format provider factory.

System.Func<System.Windows.DependencyObject, DataProviderBase> getAttachedDataProvider A function that can get the attached to RadRichTextBox data provider.

System.Action<System.Windows.DependencyObject, DataProviderBase> setAttachedDataProvider A function that can set the attached to RadRichTextBox data provider.

System.Windows.DependencyProperty attachedDataProviderProperty The attached data provider property.

System.Object newValue The new value.

UpdateDocument()

Updates the document inside the control.

Declaration

public virtual void UpdateDocument()

UpdateString()

Updates the string representing the document.

Declaration

public virtual void UpdateString()

Events

ImportException

Occurs when the import causes an exception.

Declaration

public event EventHandler<DataProviderImportExceptionEventArgs> ImportException

Event Type

System.EventHandler<DataProviderImportExceptionEventArgs>

SetupDocument

Occurs when the data provider creates a new document.

Declaration

public event EventHandler<SetupDocumentEventArgs> SetupDocument

Event Type

System.EventHandler<SetupDocumentEventArgs>

StringChanged

Occurs after the string associated to the provider changes.

Declaration

protected event EventHandler StringChanged

Event Type

System.EventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)

See Also

System.Windows.FrameworkElement