Documentation

Class BinaryDataProviderBase

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

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
BinaryDataProviderBase
DocxDataProvider
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 BinaryDataProviderBase : FrameworkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop

Constructors

BinaryDataProviderBase(IDocumentFormatProvider, RadObject, RadProperty)

Initializes a new instance of the BinaryDataProviderBase class.

Declaration
public BinaryDataProviderBase(IDocumentFormatProvider formatProvider, RadObject propertyOwner, RadProperty bytesProperty)
Parameters
IDocumentFormatProvider formatProvider

The format provider.
RadObject propertyOwner

The property owner.
RadProperty bytesProperty

The bytes property.

BinaryDataProviderBase(IDocumentFormatProvider, RadProperty)

Initializes a new instance of the BinaryDataProviderBase class.

Declaration
public BinaryDataProviderBase(IDocumentFormatProvider formatProvider, RadProperty bytesProperty)
Parameters
IDocumentFormatProvider formatProvider

The format provider.
RadProperty bytesProperty

The bytes property.

BinaryDataProviderBase(IDocumentFormatProvider, RadRichTextBox, RadProperty)

Declaration
public BinaryDataProviderBase(IDocumentFormatProvider formatProvider, RadRichTextBox propertyOwner, RadProperty stringProperty)
Parameters
IDocumentFormatProvider formatProvider

RadRichTextBox propertyOwner

RadProperty stringProperty

Fields

FormatProviderProperty

The format provider property. It gets or sets the associated format provider.

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

Bytes

Gets or sets the bytes.

Declaration
protected IList<byte> Bytes { get; set; }
Property Value
System.Collections.Generic.IList<System.Byte>

The bytes.

FormatProvider

Gets or sets the IDocumentFormatProvider thas is used when converting the document

Declaration
public IDocumentFormatProvider FormatProvider { get; set; }
Property Value
IDocumentFormatProvider

RichTextBox

Gets or sets the RadRichTextBox this DataProvider is attached to.

Declaration
public RadRichTextBox RichTextBox { get; set; }
Property Value
RadRichTextBox

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.

BytesPropertyChangedCallback(RadObject, RadPropertyChangedEventArgs)

The callback invoked when the Bytes property changes.

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

The sender.
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs instance containing the event data.

CreateBytesProperty(String)

Creates a new property to replace the Bytes property.

Declaration
protected static RadProperty CreateBytesProperty(string name)
Parameters
System.String name

The name.
Returns
RadProperty

OnBytesChanged()

Called after the byte[] associated with this instance changes.

Declaration
protected virtual void OnBytesChanged()

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 DataProvider creates new document.

Declaration
protected virtual void OnSetupDocument(RadDocument document)
Parameters
RadDocument document

The new document.

SetValueRespectingOneWayBindings(IList<Byte>)

Sets the value respecting one way bindings.

Declaration
protected void SetValueRespectingOneWayBindings(IList<byte> value)
Parameters
System.Collections.Generic.IList<System.Byte> value

The value.

Unbind(RadRichTextBox)

Unbinds the specified RadRichTextBox.

Declaration
protected virtual void Unbind(RadRichTextBox radRichTextBox)
Parameters
RadRichTextBox radRichTextBox

The RRadRichTextBox.

UpdateBytes()

Updates the bytes.

Declaration
public virtual void UpdateBytes()

UpdateDocument()

Updates the document.

Declaration
public virtual void UpdateDocument()

Events

BytesChanged

Occurs after the byte[] associated with this instance changes.

Declaration
protected event EventHandler BytesChanged
Event Type
System.EventHandler

ImportException

Occurs when an exception is thrown during import.

Declaration
public event EventHandler<DataProviderImportExceptionEventArgs> ImportException
Event Type
System.EventHandler<DataProviderImportExceptionEventArgs>

SetupDocument

Fires when the DataProvider creates new document.

Declaration
public event EventHandler<SetupDocumentEventArgs> SetupDocument
Event Type
System.EventHandler<SetupDocumentEventArgs>

Extension Methods

See Also

System.Windows.FrameworkElement