Class DataProviderBase

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

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
DataProviderBase
HtmlDataProvider
RtfDataProvider
TxtDataProvider
XamlDataProvider
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents.FormatProviders
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class DataProviderBase : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop

Constructors

DataProviderBase(ITextBasedDocumentFormatProvider, RadProperty)

Initializes a new instance of the DataProviderBase class.

Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, RadProperty stringProperty)
Parameters
ITextBasedDocumentFormatProvider formatProvider

The format provider.
RadProperty stringProperty

The string property.

DataProviderBase(ITextBasedDocumentFormatProvider, FrameworkElement, RadProperty)

Initializes a new instance of the DataProviderBase class.

Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, FrameworkElement propertyOwner, RadProperty stringProperty)
Parameters
ITextBasedDocumentFormatProvider formatProvider

The format provider.
FrameworkElement propertyOwner

The property owner.
RadProperty stringProperty

The string property.

DataProviderBase(ITextBasedDocumentFormatProvider, RadRichTextBox, RadProperty)

Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, RadRichTextBox propertyOwner, RadProperty stringProperty)
Parameters
ITextBasedDocumentFormatProvider formatProvider

RadRichTextBox propertyOwner

RadProperty stringProperty

Fields

FormatProviderProperty

The format provider property.

Declaration
public static readonly RadProperty FormatProviderProperty
Field Value
RadProperty

RichTextBoxProperty

The rich text box property.

Declaration
public static readonly RadProperty RichTextBoxProperty
Field Value
RadProperty

UpdateSourceTriggerProperty

The update source trigger property.

Declaration
public static readonly RadProperty UpdateSourceTriggerProperty
Field Value
RadProperty

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 RadProperty CreateStringProperty(string name)
Parameters
System.String name

The name.
Returns
RadProperty

OnAttachedDataProviderPropertyChanged(RadObject, RadPropertyChangedEventArgs)

Called after changing the attached data provider.

Declaration
public static void OnAttachedDataProviderPropertyChanged(RadObject dependencyObject, RadPropertyChangedEventArgs e)
Parameters
RadObject dependencyObject

The dependency object.
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs 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(RadObject, RadPropertyChangedEventArgs)

A callback invoked when the associated string is changed.

Declaration
protected static void StringPropertyChangedCallback(RadObject sender, RadPropertyChangedEventArgs e)
Parameters
RadObject sender

The sender.
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs 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(RadObject, Func<RadRichTextBox, DataProviderBase>, Func<RadObject, DataProviderBase>, Action<RadObject, DataProviderBase>, RadProperty, Object)

Updates the attached data provider.

Declaration
public static void UpdateAttachedDataProvider(RadObject dependencyObject, Func<RadRichTextBox, DataProviderBase> formatProviderFactory, Func<RadObject, DataProviderBase> getAttachedDataProvider, Action<RadObject, DataProviderBase> setAttachedDataProvider, RadProperty attachedDataProviderProperty, object newValue)
Parameters
RadObject dependencyObject

The dependency object.
System.Func<RadRichTextBox, DataProviderBase> formatProviderFactory

The format provider factory.
System.Func<RadObject, DataProviderBase> getAttachedDataProvider

A function that can get the attached to RadRichTextBox data provider.
System.Action<RadObject, DataProviderBase> setAttachedDataProvider

A function that can set the attached to RadRichTextBox data provider.
RadProperty 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

See Also

System.Windows.FrameworkElement