Back to Devexpress

IRichEditDocumentServer Members

officefileapi-devexpress-dot-xtrarichedit-dot-iricheditdocumentserver-dot-underscore-members.md

latest20.4 KB
Original Source

IRichEditDocumentServer Members

Interface of a rich text engine providing the essential Rich Editor functionality.

Properties

NameDescription
DocBytesGets or sets the document content as an array of bytes in Microsoft Word 97-2003 (Doc) format.
DocmBytesGets or sets the document content as an array of bytes in Office Open XML WordprocessingML Macro-Enabled Document (Docm) format.
DocumentProvides access to a Document interface, representing the document contained in the server.
DocxBytesGets or sets the document content as an array of bytes in Office Open XML (DOCX) format.
DotBytesGets or sets the document content as an array of bytes in Microsoft Word 97-2007 Template (DOT) format.
DotmBytesGets or sets the document content as an array of bytes in Microsoft Office Open XML Macro-Enabled Template (DOTM) format.
DotxBytesGets or sets the document content as an array of bytes in DOTX (Microsoft Office Open XML macro-free template) format.
DpiXGets the current dpi value for the X-coordinate.
DpiYGets the current dpi value for the Y-coordinate.
FlatOpcBytesGets or sets the document content as an array of bytes in FlatOpc (Microsoft Word XML Document, .xml) format.
FlatOpcMacroEnabledBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format.
FlatOpcMacroEnabledTemplateBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format.
FlatOpcTemplateBytesGets or sets the document content as an array of bytes in FlatOpcTemplate (Microsoft Word XML Template, .xml) format.
HtmlTextGets or sets the content as HTML text.
HyphenationDictionariesProvides access to the collection of hyphenation dictionaries.
InnerServerFor internal use.
IsDisposedFor internal use. Gets a value indicating whether the control has been disposed of.
LayoutUnitGets or sets a unit of measure used for a document model layout.
MhtTextGets or sets the document content as MHT text.
ModelFor internal use.
ModifiedGets or sets a value that indicates that the document contents is modified since it was last saved.
OdtBytesGets or sets the document content as an array of bytes in Open Office Text (.odt) format.
OptionsProvides access to the variety of options which can be specified for the RichEditDocumentServer.
RtfTextGets or sets the formatted text content of the document.
TextGets or sets the plain text content of the document.
UnitGets or sets a unit of measure used within the RichEditDocumentServer.
WordMLTextGets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format.

Methods

NameDescription
AddService(Type, ServiceCreatorCallback, Boolean)Adds the specified service to the service container, and optionally promotes the service to parent service containers. Inherited from IServiceContainer.
AddService(Type, ServiceCreatorCallback)Adds the specified service to the service container. Inherited from IServiceContainer.
AddService(Type, Object, Boolean)Adds the specified service to the service container, and optionally promotes the service to any parent service containers. Inherited from IServiceContainer.
AddService(Type, Object)Adds the specified service to the service container. Inherited from IServiceContainer.
CreateMailMergeOptions()Creates an object for specifying the options used in mail merge operations.
CreateNewDocument(Boolean)Creates a new blank document.
Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
GetService(Type)Gets the service object of the specified type. Inherited from IServiceProvider.
GetService<T>()Gets service of the specified type.
LoadDocument(Stream, DocumentFormat)Loads a document from a stream, specifying the document format.
LoadDocumentTemplate(Stream, DocumentFormat)Loads a document template from a stream with specific document format.
MailMerge(Document)Merges the current document and sends the result to the specified Document.
MailMerge(MailMergeOptions, Document)Merges the current document using the specified options, and sends the result to the specified Document.
MailMerge(MailMergeOptions, IRichEditDocumentServer)Obsolete. Merges the current document using the specified options and sends the result to the specified RichEditDocumentServer instance.
MailMerge(MailMergeOptions, Stream, DocumentFormat)Merges the current document using the specified options and sends the result to the specified stream in a specified format.
MailMerge(MailMergeOptions, String, DocumentFormat)Merges the current document using the specified options and sends the result to the specified file in a specified format.
MailMerge(IRichEditDocumentServer)Obsolete. Merges the current document and sends the result to the specified RichEditDocumentServer instance.
MailMerge(Stream, DocumentFormat)Merges the current document and sends the result to the specified stream in a specified format.
MailMerge(String, DocumentFormat)Merges the current document and sends the result to the specified file in a specified format.
RemoveService(Type, Boolean)Removes the specified service type from the service container, and optionally promotes the service to parent service containers. Inherited from IServiceContainer.
RemoveService(Type)Removes the specified service type from the service container. Inherited from IServiceContainer.
ReplaceService<T>(T)Performs a service substitution.
SaveDocument(DocumentFormat, EncryptionSettings)Saves the document to a byte array in the specified file format and encrypts it with a password.
SaveDocument(DocumentFormat)Saves the document to a byte array in the specified file format.
SaveDocument(Stream, DocumentFormat, EncryptionSettings)Saves the document to a stream, specifying the document’s format and encryption options.
SaveDocument(Stream, DocumentFormat)Saves the document to a stream, specifying the document’s format.

Events

NameDescription
AfterExportOccurs after the document is successfully exported.
BeforeEncodingDetectionOccurs before detecting encoding of the loaded plain text or HTML content.
BeforeExportOccurs before the document is saved (exported to a certain format).
BeforeImportOccurs before a document is loaded (imported from an external source).
CalculateDocumentVariableFires when the DOCVARIABLE field is updated.
ContentChangedOccurs when the document content was changed.
CustomPropertiesChangedOccurs after one of the DocumentCustomProperties has changed.
DocBytesChangedFor internal use.
DocmBytesChangedFor internal use.
DocumentClosingOccurs when a document that has not yet been saved is about to be closed.
DocumentEncryptionChangedOccurs after one of the DocumentEncryption properties has been changed.
DocumentLoadedOccurs after a document is loaded.
DocumentPropertiesChangedOccurs after one of the DocumentProperties has changed.
DotBytesChangedFor internal use.
DotmBytesChangedFor internal use.
DotxBytesChangedFor internal use.
EmptyDocumentCreatedOccurs when a new document is created.
EncryptedFileIntegrityCheckFailedRaises when the encrypted file did not pass the data integrity verification.
EncryptedFilePasswordCheckFailedOccurs when the encryption password is empty or invalid.
EncryptedFilePasswordRequestedRaises when the RichEditDocumentImportOptions.EncryptionPassword property is not set or returns an invalid password.
FlatOpcBytesChangedFor internal use.
FlatOpcMacroEnabledBytesChangedFor internal use.
FlatOpcMacroEnabledTemplateBytesChangedFor internal use.
FlatOpcTemplateBytesChangedFor internal use.
HtmlTextChangedFor internal use.
InitializeDocumentOccurs before a document is loaded. Handle this event to set initial document settings.
MailMergeFinishedFires when mail merge is completed.
MailMergeRecordFinishedFires after each data record is merged with the document in the mail merge process.
MailMergeRecordStartedFires before each data record is merged with the document in the mail merge process.
MailMergeStartedFires before mail merge starts.
MhtTextChangedFor internal use.
ModifiedChangedOccurs when the value of the IRichEditDocumentServer.Modified property is changed.
OpenDocumentBytesChangedFor internal use.
OpenXmlBytesChangedFor internal use.
RtfTextChangedFor internal use.
SelectionChangedFires in response to changing a selection in the document.
TrackedMovesConflictOccurs when moved text has been changed since it was moved.
UnitChangedFires after the Unit property is changed.
UnitChangingFires before the Unit property is changed.
WordMLTextChangedFor internal use.

See Also

IRichEditDocumentServer Interface

DevExpress.XtraRichEdit Namespace