ClassDataProviderBase
Represents a wrapper of ITextBasedDocumentFormatProvider allowing the latter to be used in data binding scenarios.
Definition
Namespace:Telerik.WinForms.Documents.FormatProviders
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class DataProviderBase : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDropInheritance: objectDisposableObjectRadObjectRadElementVisualElementUIElementFrameworkElementDataProviderBase
Derived Classes:
Implements:
Inherited Members
Constructors
DataProviderBase(ITextBasedDocumentFormatProvider, FrameworkElement, RadProperty)
Initializes a new instance of the DataProviderBase class.
Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, FrameworkElement propertyOwner, RadProperty stringProperty)Parameters
formatProvider
ITextBasedDocumentFormatProvider
The format provider.
propertyOwner
The property owner.
stringProperty
The string property.
DataProviderBase(ITextBasedDocumentFormatProvider, RadProperty)
Initializes a new instance of the DataProviderBase class.
Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, RadProperty stringProperty)Parameters
formatProvider
ITextBasedDocumentFormatProvider
The format provider.
stringProperty
The string property.
DataProviderBase(ITextBasedDocumentFormatProvider, RadRichTextBox, RadProperty)
Declaration
public DataProviderBase(ITextBasedDocumentFormatProvider formatProvider, RadRichTextBox propertyOwner, RadProperty stringProperty)Parameters
formatProvider
ITextBasedDocumentFormatProvider
propertyOwner
stringProperty
Fields
FormatProviderProperty
The format provider property.
Declaration
public static readonly RadProperty FormatProviderPropertyField Value
RichTextBoxProperty
The rich text box property.
Declaration
public static readonly RadProperty RichTextBoxPropertyField Value
UpdateSourceTriggerProperty
The update source trigger property.
Declaration
public static readonly RadProperty UpdateSourceTriggerPropertyField Value
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 RadProperty CreateStringProperty(string name)Parameters
name
The name.
Returns
OnAttachedDataProviderPropertyChanged(RadObject, RadPropertyChangedEventArgs)
Called after changing the attached data provider.
Declaration
public static void OnAttachedDataProviderPropertyChanged(RadObject dependencyObject, RadPropertyChangedEventArgs e)Parameters
dependencyObject
The dependency object.
e
The RadPropertyChangedEventArgs 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(RadObject, RadPropertyChangedEventArgs)
A callback invoked when the associated string is changed.
Declaration
protected static void StringPropertyChangedCallback(RadObject sender, RadPropertyChangedEventArgs e)Parameters
sender
The sender.
e
The RadPropertyChangedEventArgs instance containing the event data.
Unbind(RadRichTextBox)
Unbinds the specified RadRichTextBox instance.
Declaration
protected virtual void Unbind(RadRichTextBox radRichTextBox)Parameters
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
dependencyObject
The dependency object.
formatProviderFactory
Func<RadRichTextBox, DataProviderBase>
The format provider factory.
getAttachedDataProvider
Func<RadObject, DataProviderBase>
A function that can get the attached to RadRichTextBox data provider.
setAttachedDataProvider
Action<RadObject, DataProviderBase>
A function that can set the attached to RadRichTextBox data provider.
attachedDataProviderProperty
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.