ClassDataProviderBase
Represents a wrapper of ITextBasedDocumentFormatProvider allowing the latter to be used in data binding scenarios.
Definition
Namespace:Telerik.Windows.Documents.FormatProviders
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class DataProviderBase : FrameworkElementInheritance: objectDataProviderBase
Derived Classes:
Constructors
DataProviderBase(ITextBasedDocumentFormatProvider, DependencyProperty)
Initializes a new instance of the DataProviderBase class.
Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, DependencyProperty stringProperty)Parameters
formatProvider
ITextBasedDocumentFormatProvider
The format provider.
stringProperty
DependencyProperty
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
formatProvider
ITextBasedDocumentFormatProvider
The format provider.
propertyOwner
FrameworkElement
The property owner.
stringProperty
DependencyProperty
The string property.
Fields
FormatProviderProperty
The format provider property.
Declaration
public static readonly DependencyProperty FormatProviderPropertyField Value
DependencyProperty
RichTextBoxProperty
The rich text box property.
Declaration
public static readonly DependencyProperty RichTextBoxPropertyField Value
DependencyProperty
UpdateSourceTriggerProperty
The update source trigger property.
Declaration
public static readonly DependencyProperty UpdateSourceTriggerPropertyField Value
DependencyProperty
Properties
FormatProvider
Gets or sets the ITextBasedDocumentFormatProvider that is used when converting the document.
Declaration
public ITextBasedDocumentFormatProvider FormatProvider { get; set; }Property Value
RichTextBox
Gets or sets the RadRichTextBox this DataProvider is attached to.
Declaration
public RadRichTextBox RichTextBox { get; set; }Property Value
String
Gets or sets the string representing the document.
Declaration
protected string String { get; set; }Property Value
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
The RadRichTextBox.
CreateStringProperty(string)
Creates a custom string property.
Declaration
protected static DependencyProperty CreateStringProperty(string name)Parameters
name
The name.
Returns
DependencyProperty
OnAttachedDataProviderPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Called after changing the attached data provider.
Declaration
public static void OnAttachedDataProviderPropertyChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)Parameters
dependencyObject
DependencyObject
The dependency object.
e
DependencyPropertyChangedEventArgs
The DependencyPropertyChangedEventArgs instance containing the event data.
OnImportException(DataProviderImportExceptionEventArgs)
Raises the event.
Declaration
protected virtual void OnImportException(DataProviderImportExceptionEventArgs args)Parameters
args
DataProviderImportExceptionEventArgs
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
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
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
sender
DependencyObject
The sender.
e
DependencyPropertyChangedEventArgs
The DependencyPropertyChangedEventArgs instance containing the event data.
Unbind(RadRichTextBox)
Unbinds the specified RadRichTextBox instance.
Declaration
protected virtual void Unbind(RadRichTextBox radRichTextBox)Parameters
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
dependencyObject
DependencyObject
The dependency object.
formatProviderFactory
Func<RadRichTextBox, DataProviderBase>
The format provider factory.
getAttachedDataProvider
Func<DependencyObject, DataProviderBase>
A function that can get the attached to RadRichTextBox data provider.
setAttachedDataProvider
Action<DependencyObject, DataProviderBase>
A function that can set the attached to RadRichTextBox data provider.
attachedDataProviderProperty
DependencyProperty
The attached data provider property.
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> ImportExceptionEvent Value
SetupDocument
Occurs when the data provider creates a new document.
Declaration
public event EventHandler<SetupDocumentEventArgs> SetupDocumentEvent Value
StringChanged
Occurs after the string associated to the provider changes.